streamby-core 0.37.0 → 0.39.0

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # Changelog
 
+## 0.39.0
+
+### Added
+
+- **Every resource of a project has its own list**, so a client fetches the one it shows instead
+  of the whole project (which still carries them all). New: `GET /projects/:id/exports` (what
+  each export is, as the project lists them: not its schema nor its credentials),
+  `GET /projects/:id/integrations` and `GET /projects/:id/origins`. They answer `{ data }`, as
+  the existing lists do (`connections`, `connections/db`, `connections/storage`, `members`,
+  `pipelines`, `workflow`), and are for the project's members. With an API token, the exports
+  need `exports:read` and the other two `project:read`.
+
+## 0.38.0
+
+### Added
+
+- **Uploading and downloading files from the MCP server**, so an agent can bring files from and
+  to the tools it works with (Blender's or Godot's own MCP, a script). The file never goes
+  through the conversation: the tools give signed URLs, and the tool that has the file uploads
+  or downloads it directly. See the README for an example with Blender.
+  - `request_asset_upload` (`assets:write`): a new asset, or a new version of one, and the URL
+    to upload its file to.
+  - `get_asset_download_url` (`assets:read`): a URL to download an asset's file, its latest
+    version or an earlier one. `list_asset_versions` lists them.
+- **Asset versions are kept, and an asset's URL doesn't change when it's replaced.** A new
+  version (`replace-url`, from the UI too) is still uploaded to the asset's own key, so a site
+  that links to the asset shows the new one. Before that, the current version is copied to a
+  key of its own, `<key>.v<n>.<ext>`, and recorded in `asset_versions` (an asset's first
+  version is recorded on upload; an older asset gets it when it's first replaced). If it can't
+  be copied, nothing is replaced and no upload URL is given. The `replace-url` routes answer
+  the new version's `versionId` and `version`. Deleting an asset deletes every key of it.
+  - New `StorageAdapter.copyFile`, implemented by the S3 adapter. With an adapter without it,
+    asking for a new version answers 501.
+  - StreamBy doesn't set `Cache-Control` on uploads, so a browser or a CDN may serve a replaced
+    asset's earlier version for a while: set it where the files are served (see the README).
+- `GET /projects/:projectId/assets/:fileId/download-url` (`?versionId=` for an earlier version):
+  a signed URL that downloads the file with its name, wherever it's stored.
+- **Deliverables**: an asset, or one of its versions, delivered for a production shot or for an
+  export, kept in the NoSQL database's `deliverables` collection. `GET`, `POST` and
+  `DELETE /projects/:projectId/deliverables` list (by `shotId` or `exportId`), mark and remove
+  them; `list_deliverables`, `mark_deliverable` and `remove_deliverable` in the MCP server.
+  Deleting a shot, a sequence, an export or an asset removes its deliverables.
+- **`mcp.signedUrlTtl`**: how long the signed URLs given to an API token work, also when it
+  lists files. Default: 15 minutes to upload, 5 to download. A session's are as before.
+- `StorageAdapter.getPresignedUploadUrl` and `getPresignedGetUrl` take how long the URL works
+  (and `getPresignedGetUrl` the name to download it with).
+
+- `GET /projects/:id` answers `hasProductionData`: whether the project has production
+  sequences, so a client can show them even without a production node in its workflow.
+
+### Changed
+
+- **Production data is checked before it's saved.** Sequences, shots and tasks need a name
+  that isn't blank; a status must be `todo`, `in_progress`, `review` or `done`, and a task's
+  priority `low`, `medium` or `high`; a shot's `assignedTo` must list active members of the
+  project, and a task's be one of them (or null); a due date must be a date. Otherwise they
+  answer 400. A shot is made only in a sequence of the project, and a task only in a shot of
+  it (404 otherwise).
+- The MCP tools for shots take `assignedTo` as a list of user ids, as the API does, and their
+  statuses and priorities are listed in their schema.
+- **The MCP tools take the path a user does.** `create_sequence`, `create_shot` and
+  `create_task` first add a production node (a Shot node) to the project's workflow when it
+  has none, as dropping one on the canvas does, and make nothing if it can't be added. So they
+  need `workflow:write` as well as `production:write`. Each tool's description says where its
+  result shows in the UI.
+
+### Fixed
+
+- **Deleting production data leaves nothing behind.** Deleting a sequence deletes its shots'
+  tasks too (they were left), and deleting a project deletes its sequences, shots, tasks and
+  deliverables. Deleting a sequence that doesn't exist answers 404.
+- **Only editors and admins upload a new version of an asset.** The `replace-url` routes let
+  any member of the project, a viewer included, replace an asset's file.
+- The ingest job no longer records a second version of the file an upload already recorded.
+
 ## 0.37.0
 
 ### ⚠️ Breaking changes