Compare commits

...
712 Commits
Author SHA1 Message Date
yiling 657cd761bc Release v0.4.7 2026-09-19 16:01:20 +08:00
Yiling-J de634a5dc5 feat(asset): show poster and hover preview while video is transcoding (#419)
* feat(asset): show poster and hover preview while video is transcoding

Generate and persist the sprite (and its poster) before the proxy
transcodes run, so the poster/sprite are available in the file list
while the asset is still processing.

Render the preview in the file card behind a translucent processing
overlay instead of a blank skeleton, and replace hardcoded status text
with existing i18n keys.

* feat(asset): pulse the cover and show Preparing/Uploading labels while processing

Drop the processing text overlay on the file card preview in favour of a
subtle pulsing opacity on the cover, and show "Uploading..."/"Preparing..."
in the creator row so the real author and date only appear once the asset
is ready.

* feat(asset): use a hollow ring for the preparing placeholder

Match the geometry of the upload progress ring (empty inside, no
percentage) and hide the duration badge while processing, so the
upload-to-processing transition reads as one continuous animation.

* style(asset): shrink-only preparing ring in muted grey at fixed opacity

Animate only the ring size (1 -> 0.8 -> 1) and hold a constant 0.6
opacity, using a muted grey stroke instead of primary.
2026-09-19 15:25:41 +08:00
Yiling-J 09b65a1eb6 feat(asset): Recently Deleted previews, retention countdown, and version stack delete/restore (#418)
* feat(asset): improve Recently Deleted previews and retention indicators

- Include soft-deleted children when building folder previews for the
  Recently Deleted view, and resolve deleted version stacks to their
  latest version so a trashed folder shows what was inside it.
- Add a "days left" badge (clock + Nd) to file and folder cards in the
  Recently Deleted view, placed to the left of the comments badge.
- Fix an issue where deleting or restoring a version stack from the file
  list did nothing because the WebUI dropped version_stack items before
  calling the API.
- Share the 30-day trash retention window through TRASH_RETENTION_DAYS.

* test(asset): use typed MediaInfo in recently-deleted preview tests

Replace the explicit any cast with a fully typed MediaInfo object so the new tests comply with the no-explicit-any policy.
2026-09-19 11:36:14 +08:00
Yiling-J b52b2ce7d8 fix(transcode): preserve trashed status during background jobs and handle permanent purge (#416)
* fix(transcode): preserve trashed status during background jobs and handle permanent purge

* fix(workflow): clear heartbeat and add info logs on task cancellation

* fix(transcode): terminate media processes and guard task activities on cancellation

- Pass AbortSignal to ffmpeg and pdftoppm child processes in transcodeService to terminate processes on task cancellation
- Add local task AbortController context and cancellation guards in executeActivity to prevent subsequent workflow activities
- Forward taskId and cancellation signals in transcode, screenshot, and PDF activities
- Use updateMany instead of update in task activities to eliminate Prisma P2025 errors on purged task records

* fix(workflow): allow cleanup activities in finally blocks during task cancellation

Remove blanket cancellation check in executeActivity so that workflows can execute cleanup and failure handling activities in catch and finally blocks upon cancellation, while relying on AbortSignal in active activities to abort execution.

* docs(changelog): improve user friendliness of changelog entries and formatting example

* docs(agents): update changelog guidelines to emphasize end-user friendly descriptions

* fix(transcode): handle queued cancellation and delete races in media workflow
2026-09-19 10:40:49 +08:00
Yiling-J 145aa6bfb4 fix(webui,core): center breadcrumb menu on chevron and fix proxy download filename (#417) 2026-09-18 23:14:54 +08:00
Yiling-J a91d8c4521 feat(settings): add FFmpeg threads setting for media processing (#415)
* feat(settings): add FFmpeg threads setting for media processing

* style(settings): add bottom padding to media processing page
2026-09-18 13:30:33 +08:00
Yiling-J 3a509537fd feat(changelog): add CHANGELOG.md, release extraction script, and developer guidelines (#414)
* feat(changelog): add CHANGELOG.md, release extraction script, and developer guidelines

* docs(agents): simplify changelog guidelines for brevity
2026-09-18 11:57:25 +08:00
yiling 76ffb51bb2 Release v0.4.6 2026-09-17 21:58:10 +08:00
Yiling-J ca94e51424 fix(api): enforce SHUMAI_DEMO_MODE for API token and CLI requests (#413) 2026-09-17 21:47:07 +08:00
Yiling-J d8621a53b6 docs: add NLE export and Premiere Pro UXP plugin documentation (#412)
* docs: add NLE export and Premiere Pro UXP plugin documentation

* docs: mark Premiere Pro UXP plugin as experimental
2026-09-17 21:32:41 +08:00
Yiling-J e2f741eda6 feat(settings): add team appearance setting to hide agent features (#411)
* feat(settings): add team appearance setting to hide agent features

Add an Appearance subpage under Team Settings allowing team owners to toggle appearance.hideAgent for the team. Return appearance.hideAgent in the user-metadata API, and conditionally hide the AGENTS.md button, agent chatbot sidebar, and chatbot trigger button in the WebUI.

* refactor(settings): add strongly typed TeamSettingsResponse to remove explicit any

Introduce TeamSettingsResponse and TeamAppearanceSettings in @shumai/dtos, type TeamService.getSettings and updateSettings, and eliminate the explicit any cast in AppearanceSettings.tsx.
2026-09-17 18:31:43 +08:00
Yiling-J 7af3647913 fix(premiere-uxp): scope sequence links by server endpoint and surface sync errors (#409)
* fix(premiere-uxp): scope sequence links by server endpoint and surface sync errors

- Add optional endpoint property to LinkedSequenceAsset to record originating server
- Implement normalizeEndpoint and isSameEndpoint helpers in utils/url
- Skip polling foreign sequence links in autoSyncService when connected to a different server
- Display informative Server: <host> badge and disable manual sync with tooltip for foreign links in SequencesView
- Guard comment fallback in removeSequenceLink and link matching in FileListView by endpoint
- Throw on non-200 responses in fetchAssetComments and display error toast on failed manual sync
- Add comprehensive unit tests covering endpoint normalization, foreign link skipping, and error toast handling
- Rebuild and package shumai-premiere.ccx

* fix(premiere-uxp): filter out foreign endpoint sequence links from sequences tab

- Filter all sequence links in SequencesView to only display links matching the current server endpoint
- Filter existing sequence links in LinkSequenceDialog by endpoint so foreign sequences appear as ready to link on the current server
- Ensure onLinkCountChange in FileListView and SequencesView only counts sequences linked to the active server
- Add 'Browse Assets to Link' action button to the SequencesView unified empty state
- Update SequencesView tests to verify foreign links are completely hidden and link counts are scoped
- Rebuild and package shumai-premiere.ccx

* fix(premiere-uxp): show file creation time on cards and remove sequence icon in link dialog

* fix(premiere-uxp): remove browse button in sequences empty state
2026-09-17 16:37:11 +08:00
Yiling-J 12f99797d2 fix(premiere-uxp): preserve remote cloud storage presigned URLs in asset resolution (#408)
- Stop rewriting absolute URLs in resolveAssetUrl to prevent overwriting cloud storage hosts (e.g. Cloudflare R2, S3) with the plugin endpoint
- Prepend endpoint to relative paths only (e.g. /files/..., /api/...)
- Resolve download URLs through resolveAssetUrl before fetch in importAssetIntoPremiere
- Update unit tests to ensure absolute URLs remain intact and relative download paths resolve correctly
- Rebuild and package shumai-premiere.ccx
2026-09-17 16:37:11 +08:00
Yiling-J 1796de8eda feat(premiere-uxp): introduce Adobe Premiere Pro UXP plugin for Shumai (#407)
* feat(premiere-uxp): use native Bun bundler and build script instead of Vite

* feat(premiere-uxp): switch FileListView to use Search API consistent with WebUI

* feat(premiere-uxp): add on-demand jpeg preview conversion for uxp compatibility

* feat(premiere-uxp): integrate spectrum web components (swc)

* fix(premiere-uxp): align swc packages with 0.37.0 and fix auth layout

* feat(premiere-uxp): use horizontal 2-column card view for projects and files

* style(premiere-uxp): enlarge file preview by 20% and add row padding

* fix(premiere-uxp): prevent card squishing and overflow with large item counts

* fix(premiere-uxp): change host in manifest to single object

* docs(premiere-uxp): add AGENTS.md with SWC preferences and UXP layout rules

* feat(premiere-uxp): integrate spectrum web components across plugin views

* fix(premiere-uxp): remove breadcrumb icons and use slash separator

* feat(premiere-uxp): add collapsible folder and file sections with infinite scroll

* feat(premiere-uxp): update file card layout with right column info and clean preview

* fix(premiere-uxp): use raw text for file card details and fix black icons

* style(premiere-uxp): use contain object-fit and black background for file card preview

* fix(premiere-uxp): refine header logo, sticky title bars, circular badges, and controls

* fix(premiere-uxp): replace stroke icons with spectrum workflow icons

* fix(premiere-uxp): switch icon buttons to swc sp-button with icon-only and slot=icon

* fix(premiere-uxp): vertically center endpoint text in header

* feat(premiere-uxp): add asset and proxy import support into Premiere Pro

- Implement context menu on file cards with left-click, right-click, and more action button triggers
- Support raw file import for non-video assets and video assets
- Support video proxy submenu listing ready transcode resolutions
- Add UXP native file picker save dialog and binary download orchestration
- Call Premiere Pro project.importFiles API to import downloaded assets into active project
- Add non-blocking toast notification banner for progress and status reporting
- Add unit tests for premiere host service and import orchestration

* fix(premiere-uxp): anchor import menu directly to file card using sp-action-menu

- Replace custom fixed-position ContextMenu with native SWC sp-action-menu
- Anchor menu directly to the triggered file card rather than the top-left window corner
- Support programmatic opening on file card click/contextmenu via imperative handle
- Support video submenu with Original and ready proxy options inside sp-action-menu
- Lazy load video proxies on menu open or hover
- Clean up obsolete fixed-position styles and unused backdrop overlays

* fix(premiere-uxp): align SWC packages to 0.37.0 and guard custom element registry

- Downgrade action-menu and menu SWC packages to 0.37.0 to match the rest of the workspace
- Eliminate duplicate icons-ui and sp-icon-chevron100 customElements.define calls
- Add polyfill guard to customElements.define to prevent duplicate registration errors during UXP reload

* fix(premiere-uxp): polyfill window.matchMedia for Adobe UXP

- Add window.matchMedia polyfill in polyfills.ts
- Satisfies SWC MatchMediaController used by ActionMenu and PickerBase in UXP
- Prevents TypeError when opening files page

* feat(premiere-uxp): replace context menu with card download action and video import dialog

* fix(premiere-uxp): resolve download url before save, pass null targetBin, and center download icon

* fix(premiere-uxp): resolve raw download url via download-url endpoint with fallback

* feat(premiere-uxp): use native folder picker and auto-increment conflict suffixes

* feat(premiere-uxp): add sequence linking, comment-marker sync, and navigation tabs

- Add sequence-to-asset linking with persistent project metadata storage

- Support one-way comment-to-marker timeline synchronization

- Add two-tab navigation (Sequences and Browse) using Spectrum buttons

- Add LinkSequenceDialog, SequencesView, and autoSyncService background engine

- Enforce Spectrum Workflow Icons and UXP layout rules

* feat(premiere-uxp): refine UI layouts, card interactions, and search box activation

* fix(premiere-uxp): set compact fixed width for file list search box

* fix(premiere-uxp): ensure search box click activation across full width in UXP

* fix(premiere-uxp): revert search box hacks and restore simple default sp-search layout

* feat(premiere-uxp): sync non-timestamped comments as markers at time 0

* feat(premiere-uxp): change link icon to unlink when asset is linked in file card

* fix(premiere-uxp): sync linked sequences between host project and browse view

* feat(premiere-uxp): remove synced markers on sequence unlink matching Frame.io

* fix(premiere-uxp): ensure reliable marker GUID capture, normalization, and fallback on unlink

* fix(premiere-uxp): use official Shumai logo for plugin manifest icons

* fix(premiere-uxp): use official PNG icons for manifest and plugin entrypoints

* refactor(premiere-uxp): use single 114x114 icon for plugin and panel

* feat(premiere-uxp): show file version in file list page file card

* build(premiere-uxp): check in built ccx package and update packaging configuration

* fix(premiere-uxp): address code review findings for media conversion, marker sync, and link scoping

- Reset hasJpegCover on project cover update and hasJpegPreview on asset media transcode
- Only advance synced comment metadata after confirmed marker transaction
- Normalize GUID keys and lookups in AutoSyncService map
- Restrict cached sequence link lookups to project-specific keys and prevent cross-project leakage on empty sequences
- Update built CCX distribution package
2026-09-17 11:51:03 +08:00
Yiling-J a6b7ac4383 Update project description in README.md 2026-09-16 10:22:13 +08:00
Yiling-J ca575803cb Update README with AI features and agent system details 2026-09-15 12:01:43 +08:00
Yiling-J def42cd000 feat(comment): add emoji reaction support for comments (#405)
* feat(comment): add emoji reaction support for comments

* fix(webui): adjust emoji picker trigger icon size to match mark-done icon

* fix(webui): prevent search icon and placeholder overlap in emoji picker

* fix(webui): use normal text color for reaction count

* feat(db): limit comment reaction code column to VarChar(32)
2026-09-14 15:01:36 +08:00
yiling ede52e5009 Release v0.4.5 2026-09-13 21:50:44 +08:00
Yiling-J ddbf897b27 feat(agent): use deterministic storage keys for preset avatars (#404) 2026-09-13 21:40:34 +08:00
Yiling-J 7d56b5bf90 feat(webui): show comments count badge in file card preview area (#403)
* feat(webui): show comments count badge in file card preview area

* perf(db): add index on asset_comments asset_id
2026-09-13 21:12:21 +08:00
Yiling-J 87e88396d1 feat(webui): add space key quick preview for files and folders (#402)
* feat(webui): add space key quick preview for files and folders

Allow users in file list views to press the Space key to quick preview the most recently selected item.

- Add FilePreviewDialog supporting both folder previews (icon, name, count) and real file previews (reusing FileViewer with viewer area and control bar).
- Constrain dialog to max 1920x1080 or 70vw/70vh.
- Support dismissing via close button, clicking outside, or pressing Space again (intercepted in capture phase).
- Enable across project file lists, share links, and public share views.

* feat(webui): auto play video in quick preview dialog

- Pass autoPlay prop from FilePreviewDialog through FileViewer to VideoViewer
- Configure videojs with autoplay: 'any' and handle policy rejection with muted autoplay fallback
- Add test coverage for autoPlay prop forwarding in FilePreviewDialog

* fix(webui): resolve video quick preview initialization and autoplay pause bugs

* fix(webui): support folder symlinks and password-protected shares in quick preview
2026-09-13 18:51:06 +08:00
Yiling-J c5b57ca862 feat(webui): add NLE comments export and migrate export API to POST (#401) 2026-09-13 16:29:58 +08:00
Yiling-J 3420d848cb feat(core): export comments to FCP, Premiere, Media Composer, and Resolve (#400)
* feat(core): export comments to FCP, Premiere, Media Composer, and Resolve

Add backend support to export video comments matching Frame.io export capabilities:
- DaVinci Resolve (.edl): CMX 3600 EDL with ResolveColorPurple markers and reply threading
- Avid Media Composer (.xml): OMFI StreamItems XML with TC1 / V1 track allocation and sequential frame positioning
- Adobe Premiere Pro (.xml): FCP7 XML sequence with dual marker placement on sequence and generatoritem
- Final Cut Pro 10.4.0+ (.fiojson): Flattened JSON schema with frame, timestamp, and annotation serialization

Includes DTO schema validation, AssetService export method, API route (GET /files/:fileId/comments/export), SMPTE drop-frame timecode calculations, unit tests, golden master tests, service integration tests, and API endpoint tests.

* test(core): move comments export test fixtures to test directory

* fix(core): escape asset name in Premiere XML, align Resolve FCM, and support CJK

- Escape XML special characters in <name> tag for Premiere Pro XML sequence
- Harmonize Resolve EDL FCM header and emitted timecodes using getEffectiveDropFrame
- Use RFC 5987 / RFC 6266 buildContentDisposition for CJK filenames in download headers
- Add test coverage for CJK filenames, comments, and author names across all 4 NLE formats

* fix(core): implement timezone-aware comment exports and sanitize resolve edl
2026-09-13 14:48:41 +08:00
yiling 70b81355c2 Release v0.4.4 2026-09-09 22:07:40 +08:00
yiling 1d552e4ae4 fix(sandbox): change initialization and hotreload log level to debug 2026-09-09 11:17:20 +08:00
Yiling-J b37b2172e7 fix(transcode): co-locate screenshots and derived artifacts in asset storage directory (#399)
* fix(transcode): co-locate screenshots and derived artifacts in asset storage directory

* refactor(transcode): centralize derived artifact directory resolution and strengthen upload assertions
2026-09-09 11:03:48 +08:00
Yiling-J 941000d277 feat(sandbox): abstract SandboxService and hot-reload allowed domains (#398)
* feat(sandbox): abstract SandboxService and hot-reload allowed domains

Introduce SandboxService with pluggable SandboxProvider in @shumai/core. Eliminate disruptive per-session sandbox resets by hot-reloading allowed domains via updateConfig, isolate violations per commandId, and eagerly initialize sandbox at worker/server boot.

* fix(sandbox): isolate command violations and serialize concurrent domain sync

Strictly isolate getBlockedHost per commandId to prevent false-positive blocked reporting on concurrent allowed commands. Serialize syncAllowedDomains to ensure concurrent requests during initialization or updates are never silently dropped. Add comprehensive unit tests for LocalSandboxProvider and concurrent bash commands.

* fix(agent): do not synchronize sandbox when allowedDomains is omitted

Make allowedDomains optional in CreateAgentSessionParams and only invoke sandboxService.syncAllowedDomains when allowedDomains is defined. Omit allowedDomains in generateSessionNameActivity so background chat title generation never overwrites the live sandbox allowlist.
2026-09-08 20:21:29 +08:00
Yiling-J 4a61e87a27 fix(agent): restrict pageCount and duration recommendations to matching media types (#397) 2026-09-08 14:52:37 +08:00
Yiling-J 04fd571bd9 feat(agent): enable read_asset tool for autofill agent (#396)
* feat(agent): enable read_asset tool for autofill agent

* fix(transcode): trigger autofill task for pdf assets

* fix(transcode): allow autofill task creation on all file assets

* fix(agent): require targetAssetId and teamId for autofill read_asset authorization

* feat(agent): instruct autofill agent to report failure directly if read_asset fails
2026-09-08 14:19:03 +08:00
Yiling-J 3a05332cd6 fix(agent): pass agent thinkingLevel to session name generation (#395) 2026-09-08 11:15:26 +08:00
yiling 51f63fc9e4 fix(agent): add error logging for failed session name generation 2026-09-08 10:47:36 +08:00
Yiling-J b35c824a27 feat(transcode): optimize video operations using ffmpeg http range requests (#393)
* feat(transcode): optimize video operations using ffmpeg http range requests

* fix(transcode): preserve non-retryable errors and ensure mapConcurrent settles on rejection
2026-09-08 10:17:15 +08:00
Yiling-J f62df9555a fix(s3): stream downloadToFile and putObject to prevent OOM on large files (#392)
* fix(s3): stream downloadToFile and putObject to prevent OOM on large files

* fix(agent): preserve file MIME detection on download_asset and align local download directory creation
2026-09-07 19:33:13 +08:00
Yiling-J 67b767f1e8 feat(upload): S3 multipart upload with offline resume and wake lock (#391)
* feat(upload): implement S3 multipart upload with offline resume and wake lock

* fix(upload): harden S3 sign and abort authorization, await confirmation, and clean up failed multipart uploads

* fix(webui): resume multipart upload on network recovery and log online event

* fix(webui): remove offline and online toast notifications
2026-09-07 16:49:00 +08:00
yiling 62e86b703e Release v0.4.3 2026-09-06 22:22:14 +08:00
Yiling-J 6c87db0581 fix(webui): clamp file card creation info to 2 lines and show tooltip on hover (#390) 2026-09-06 22:06:03 +08:00
Yiling-J bc85dc4541 docs(agents): add image and video generation settings documentation (#389) 2026-09-06 21:21:16 +08:00
Yiling-J 659a0af2c5 feat(cli): control asset deletion via SHUMAI_ALLOW_DELETE env var (#388) 2026-09-06 19:42:10 +08:00
yiling 54d2c407b5 docs(readme): add target blank to DeepWiki badge 2026-09-06 18:28:43 +08:00
yiling 8e31d05f8a docs(readme): add Ask DeepWiki badge 2026-09-06 17:32:57 +08:00
Yiling-J 8c1e59d131 feat(agent): add asset management tools and CLI commands (#387)
* feat(agent): add asset management tools and CLI commands

* fix(core): resolve code review findings for reparenting cycles, agent deniedTools update, and CLI folder delete
2026-09-06 17:15:58 +08:00
Yiling-J b087bf73ae chore(i18n): update paraglide-js to 2.25.0 and stop checking in generated code (#386)
- Upgrade @inlang/paraglide-js to 2.25.0 in root devDependencies
- Untrack 2,700+ generated paraglide files from git index
- Ignore packages/webui/paraglide in .gitignore and .dockerignore
- Remove --no-emit-git-ignore flag from i18n:compile and i18n:watch
- Chain bun run i18n:compile into build and build-npm scripts
- Add i18n compile step in Dockerfile builder stage
- Add i18n compile step in CI workflows (.github/workflows/ci.yaml, release-npm.yaml)
- Update README.md and README_CN.md with local setup instructions for i18n compilation
2026-09-06 15:48:39 +08:00
Yiling-J a49722d5c7 feat(settings): redesign image/video settings to provider dialog with model toggles (#385) 2026-09-06 15:13:01 +08:00
Yiling-J 576d8ebe64 chore(deps): upgrade bun to 1.4.2 and update packages (#384)
* chore(deps): upgrade bun to 1.4.2 and update packages

- Upgrade Bun to 1.4.2 in Dockerfile, CI workflows, and release workflows.
- Update dependencies across workspace with Bun 1.4.2.
- Preserve @earendil-works/pi-agent-core at 0.82.1.
- Retain stable compatible versions for database adapters and pdfjs-dist.
- Add explicit Buffer type annotation in transcode service.

* chore(deps): upgrade prisma to 7.10.0, pg to 8.23.0, and pdfjs-dist to 6.3.289

* chore(deps): revert dotenv-expand to 13.0.0
2026-09-06 11:31:05 +08:00
Yiling-J ffc1889cdc feat(media-generation): add gemini-omni-1.1-flash video model and redesign settings UI (#383)
* feat(settings): redesign image and video generation settings with tabs, card switch, and 2-box model selector

* fix(settings): remove model type checkmark, remove search inputs, and fix select box scrolling in add model dialog

* refactor(settings): remove display name input from add model dialog

* feat(media-generation): add gemini-omni-1.1-flash as default video model via google interactions api

* feat(media-generation): forward video parameters to gemini-omni-1.1-flash via system instructions and prompt
2026-09-06 09:42:21 +08:00
Yiling-J 6285ff8618 feat(agent): add built-in image and video generation tools and settings (#382)
* feat(agent): add built-in image and video generation tools and settings

* fix(settings): refine media generation layout and expose media tools in agent and quota forms

* feat(media-generation): add alibaba, bytedance, minimax, prodia, and azure providers

* feat(agent): support s3 key references for media generation and s3KeyOnly in read_asset
2026-09-06 09:28:53 +08:00
Yiling-J 1e60933cdb feat(agent): store preset avatars as real files in s3 storage (#381)
* feat(agent): store preset avatars as real files in s3 storage

* fix(agent): use inline base64 previews in dialog and remove static avatar files

* feat(agent): add 4 avatar presets and track avatarPreset in agent config

* refactor(agent): consolidate preset avatar base64 data in dtos
2026-09-04 16:39:19 +08:00
Yiling-J dd0ea05a88 feat(asset): record and display agent provenance on assets and audit logs (#380)
* feat(asset): record and display agent provenance on assets and audit logs

* style(webui): apply 30% translucent frosted glass background to bot badges

* style(webui): match bot icon badge style to thumbnail media overlay (bg-black/60 text-white)

* style(webui): use "AI" text badge with pdf overlay style instead of bot icon
2026-09-04 11:27:52 +08:00
yiling 52330869a2 Release v0.4.2 2026-09-03 21:49:37 +08:00
Yiling-J 0c561e9b39 refactor(webui): use semantic system colors in notification settings (#379) 2026-09-03 21:36:28 +08:00
Yiling-J a236cd3a97 feat(provider): add provider and model sync feature with vendored generator (#378)
* feat(provider): vendor and adapt pi model generator

- Vendor generate-models.ts, model-data.ts, and models-dev-reasoning-options.ts from @earendil-works/pi tag v0.82.1
- Adapt imports to use @earendil-works/pi-ai and expose generateModels programmatic function
- Add compare.test.ts to verify vendored generator against original built-in catalog
- Add packages/core/src/provider/generator to eslint ignores

* feat(provider): add provider and model sync api and ui

* feat(webui): add checkbox for existing providers and clean dialog description

* feat(webui): add expand all and collapse all to sync providers dialog

* refactor(provider): remove compare.test.ts and cli overhead from generate-models

* fix(provider): add 30s timeout and strict error handling to sync catalog fetching

* fix(e2e): eliminate drag-and-drop race condition on webkit

Allow requestAnimationFrame collision updates to settle in dragCard helper before releasing pointer, and scope fileCard locator via data-testid to avoid matching sidebar tree items.
2026-09-03 21:01:14 +08:00
Yiling-J c3ef769f51 feat(provider): optimize provider and model configuration management (#377)
* feat(provider): optimize provider and model configuration management

* style(provider): use default tabs variant in provider settings dialog

* style(provider): make tabs list full width

* feat(provider): make model card row clickable and remove pencil edit icon

* feat(settings): persist active settings tab in url hash

* feat(agent): add search box and alphabetical sorting for provider and model selectors

* refactor(providers): remove frontend pagination and display all models in scrollable list

* fix(providers): address code review findings for model editing, i18n, and api protocol propagation
2026-09-03 15:16:16 +08:00
Yiling-J e58dfaa71a feat(agent): consolidate media tools into read_asset and add S3 key support to download_asset (#376)
* feat(agent): consolidate media tools into read_asset and add S3 key support to download_asset

* fix(agent): refine parameter descriptions and remove download URL from read_asset text content

* fix(agent): resolve owning asset and enforce RBAC permissions when downloading by S3 key
2026-09-02 21:51:07 +08:00
Yiling-J 35b57cc0ab feat(agent): support dynamic annotationId resolution across chat and comments (#375)
* feat(agent): improve timestamp precision and proxy selection for video screenshots

* feat(agent): support dynamic annotationId resolution across chat and comments

* fix(agent): scope annotation resolution to asset and format has_markup consistently
2026-09-02 15:17:56 +08:00
Yiling-J 5a754bcb94 feat(agent): improve timestamp precision and proxy selection for video screenshots (#374) 2026-09-01 21:15:28 +08:00
Yiling-J 64b68e7d63 feat(agent): move thread metadata to structured context XML (#373)
* feat(agent): move thread metadata to structured context XML

* feat(core): dynamically inject thread metadata in getSessionEntries
2026-09-01 17:42:56 +08:00
Yiling-J c2f477a391 fix(agent): hide main comment sessions in dashboard sessions list (#372)
* fix(agent): hide main comment sessions in dashboard sessions list

* feat(webui): auto mention comment creator when replying
2026-09-01 16:20:58 +08:00
Yiling-J 9263971653 更新 README_CN.md 以包含 Docker Compose 部署指南
添加了使用 Docker Compose 部署 Shumai 的详细说明和提示词。
2026-09-01 10:25:57 +08:00
Yiling-J 79a479c87c fix(webui): strip styles and preserve multiline text on paste in chat input (#371)
* fix(webui): strip styles and preserve multiline text on paste in chat input

* fix(db): remove custom log wait strategy in test global setup to prevent postgres startup race condition
2026-08-31 21:29:00 +08:00
Yiling-J 134eb8b7fa fix(agent): set empty details in asset tool results to avoid data duplication (#370) 2026-08-31 20:43:05 +08:00
Yiling-J e06478df88 feat(chat): support markups, attachments, and timestamps in agent 1-to-1 chat (#368)
* feat(chat): support markups, attachments, and timestamps in agent 1-to-1 chat

* feat(chat): improve message card layout with inline badges and integrated assets

* fix(chat): enable image attachment thumbnails in 1-to-1 chat cards

* fix(chat): address code review feedback on input state, mentions, i18n, and session deletion

* fix(chat): replace ring with border color on selected message card
2026-08-31 20:11:27 +08:00
yiling 6e9cf8dfb6 Release v0.4.1 2026-08-30 20:26:57 +08:00
Yiling-J d2620f6911 fix(webui): prevent empty folder flash during initial loading (#367) 2026-08-30 18:43:23 +08:00
Yiling-J 4537baa6a2 feat(webui): redesign comment attachment display into compact rows (#366)
* feat(webui): redesign comment attachment display into compact rows

* feat(webui): support pure frontend image extension matching and self-contained preview dialog

* fix(webui): size image preview dialog to min(image size, 80% screen size)

* fix(webui): prevent horizontal overflow of comment attachment rows in scroll areas

* fix(webui): centralize attachment image preview ownership and localize download title
2026-08-30 17:16:20 +08:00
yiling 810e0c4cf5 fix(agent): only include duration_seconds for time-based media (video/audio) 2026-08-30 15:51:23 +08:00
yiling 07cb648183 fix(agent): use total_frames for video and total_pages for pdf in asset context 2026-08-30 15:44:59 +08:00
yiling c6602c9f1c docs(readme): add docker pulls, release, and license badges 2026-08-30 15:32:27 +08:00
Yiling-J 86032539ed feat(agent): refactor message context into unified shumai_message (#365)
* feat(agent): refactor message context into unified shumai_message

* fix(agent): persist custom_message entry type in DatabaseSessionStorage and handle message mapping defensively

* fix(agent): pass clean prompt to harness and replace optimistic messages on shumai_message stream

* fix(agent): align asset context DTO contract, sync comment attachments, and fix session stats
2026-08-30 15:25:13 +08:00
Yiling-J b2ec012e10 feat(webui): add manage versions option to file card context menu (#364) 2026-08-29 19:19:49 +08:00
Yiling-J 7fd8623684 fix(asset,webui): disallow dropping version stacks onto files and version stacks (#363)
* fix(asset,webui): disallow dropping version stacks onto files and version stacks

* fix(webui): derive isSingleFile from total drag selection and remove unused hasVersionStacks
2026-08-29 16:09:36 +08:00
Yiling-J 083753a96d refactor(agent): remove executeAgentToolWorkflow and invoke core services directly (#362)
* refactor(agent): remove executeAgentToolWorkflow and invoke core services directly

* fix(core): ensure creation atomicity, strict assetType filtering, and id-desc listing
2026-08-29 15:19:08 +08:00
yiling 4b62c31f29 Release v0.4.0 2026-08-28 20:40:33 +08:00
Yiling-J 2208d4e0e0 fix(webui): align mobile comment cards and thread vertical indicator (#361) 2026-08-28 20:26:26 +08:00
Yiling-J df7f4c3c2d Update README_CN with project management details
Added information about project management and media handling in Shumai.
2026-08-28 20:25:46 +08:00
Yiling-J 12323e1416 Enhance README with project management and media details
Added information about project management features and media processing in Shumai.
2026-08-28 20:23:38 +08:00
yiling 2edc5e1071 fix(e2e): enable ryuk container reaper for app e2e tests 2026-08-28 16:22:29 +08:00
Yiling-J 2162ed9ebe fix(webui): fix breadcrumb file dropdown trigger stretching and alignment (#360) 2026-08-28 16:07:27 +08:00
Yiling-J 6acebb73ec feat(webui): add mobile friendly file detail and public share view (#359)
* feat(webui): add mobile friendly file detail and public share view

* fix(webui): address review feedback for mobile file detail and public share view

* fix(webui): use dynamic viewport and flex column layout for mobile file viewer

* fix(webui): support iOS WebKit video fullscreen and guard requestFullscreen

* fix(webui): compact page indicator and layout in mobile PDF control bar
2026-08-28 15:11:33 +08:00
EICCIO Advisors 7a1d6c0ab5 docs: add SECURITY.md with a private disclosure path (#357)
The project has no security policy, so a researcher with a finding today has
only a public issue or Discord, both of which disclose before a fix exists.

Routes reports to GitHub private vulnerability reporting. Names deployment
manifests as in scope, since the documented quickstart is what most operators
actually run. Adds operator guidance for the three things a self-hoster owns:
the session secret, not publishing the database port, and treating the agent
as a code-execution surface.

Response timelines are left for the maintainer to set.
2026-08-28 09:21:21 +08:00
Yiling-J d16e31c0e5 feat(webui): add simplified mobile-friendly layout for file and share lists (#356)
* feat(webui): add simplified mobile-friendly layout for file and share lists

* refactor(webui): switch mobile file list layout to 1-column grid

* feat(webui): show foldertree by default in child sidebar and add close button

* feat(webui): add collapsible section headers and fix folder card full-width on mobile

* feat(webui): improve mobile breadcrumb bar with middle truncation and dual ellipsis

* fix(webui): unify breadcrumb DOM structure across desktop and mobile

* fix(webui): remove unused breadcrumbs variable in BreadcrumbNav

* fix(webui): complete and confirm file uploads on mobile and handle errors properly

* fix(webui): remove active scale animation on mobile FAB to stabilize dropdown menu anchor

* refactor(webui): use PresignedUrl type from dtos for uploadFiles and eliminate any cast

* fix(webui): scope folder card max width to desktop with responsive md:max-w-[340px]
2026-08-27 20:44:08 +08:00
Yiling-J d9a8b6a191 feat(webui): truncate long file names with 100ms hover tooltip (#355) 2026-08-27 10:54:35 +08:00
yiling 5ec4cd7fcd docs: update documentation link in README and README_CN 2026-08-26 21:44:50 +08:00
Yiling-J a7925e3c79 fix(share): hide and soft-delete symlinks when target assets are trashed (#354) 2026-08-26 21:04:38 +08:00
Yiling-J 472b420620 fix(transcode): apply team hardware acceleration and source bitrate capping to watermark transcoding (#353) 2026-08-26 17:00:11 +08:00
Yiling-J 8f55ba1d37 feat(transcode): add hardware-accelerated video transcoding support (#352)
* feat(transcode): add hardware-accelerated video transcoding support

* feat(transcode): use encoder quality modes and source-capped maxrate for video transcode

* fix(transcode): scale max bitrate for downsampled preview framerates

* fix(transcode): propagate videoBitRate in getMediaInfoActivity and update auto description
2026-08-26 16:28:14 +08:00
yiling 7b1428bf51 Release v0.3.11 2026-08-25 22:05:47 +08:00
yiling d5b3b1868e fix(webui): reload video player and reset state when switching videos in viewer 2026-08-25 21:52:15 +08:00
yiling 49f3fc0be5 fix(webui): restore full width bottom bar spanning across carousel in file viewer 2026-08-25 21:27:20 +08:00
Yiling-J 59e641ccb3 fix(webui): prevent left carousel remounting and scroll jump on file selection (#351) 2026-08-25 21:01:51 +08:00
Yiling-J 1d9268b224 feat(project): add recent viewed files section to project folder tree (#348)
* feat(project): add recent viewed files section to project folder tree

* feat(webui): disable toolbar buttons and context menu in recents page

* test(core): optimize recents cap test execution time

* feat(webui): show hint text in recents page top toolbar

* feat(webui): rename recents section to Recently Viewed

* refactor(core): consolidate recents methods into AssetService

* fix(api): forward pagination parameters in folder children endpoint (#349)

* fix(project-recents): scope views and disable recents mutations

* fix(api): allow recent views in demo mode

* fix(api): limit demo recent view exception to post
2026-08-25 18:51:24 +08:00
Yiling-J 470a4bd6f7 feat(auth): add admin password reset CLI command and reset password web UI (#347)
* feat(auth): add admin password reset CLI command and reset password web UI

* fix(auth): invalidate previous reset tokens and use AsyncLocalStorage for link capture
2026-08-25 14:35:33 +08:00
yiling 8801d59b2e docs: symlink CLAUDE.md to AGENTS.md 2026-08-25 09:50:54 +08:00
yiling 6a20e06982 Release v0.3.10 2026-08-23 21:19:45 +08:00
Yiling-J b17abce2c2 fix(kanban): improve drag-drop to column bottom, remove empty drop line, and fix timeline alignment (#346) 2026-08-23 21:11:33 +08:00
Yiling-J f67e334016 feat(kanban): update task status permissions, reporter defaults, and participant access (#345)
* feat(kanban): allow editors to change task status and default reporter to creator

* fix(kanban): hide create task button for reviewers and eliminate duplicate error toast
2026-08-23 20:38:56 +08:00
yiling c1de66520e update readme image 2026-08-23 16:53:44 +08:00
Yiling-J 37e086d822 fix(webui): sidebar selection styling, kanban active state, pointer cursors, and owner dashboard (#344)
* fix(webui): update sidebar selection styling, kanban active state, and pointer cursors

* feat(webui): move dashboard to left sidebar and prevent mount animation

* fix(e2e): update create-project test to click Home button in sidebar
2026-08-23 16:39:56 +08:00
Yiling-J d21f8ca8de fix(kanban): use true thumbnail and poster for task asset previews (#343) 2026-08-23 14:36:46 +08:00
Yiling-J 6af4e7c2ec feat(kanban): resolve latest version for linked version stack assets and update demo login text (#342) 2026-08-23 11:19:48 +08:00
Yiling-J 1f2bdc8c9e feat(agentic kanban): phase 1 not-agentic kanban board (#330)
* feat(kanban): implement AI-native kanban database models, services, and REST APIs

* feat(webui): implement team kanban board and task management

* style(webui): increase kanban dialog widths and form container

* fix(webui): ensure kanban dialogs override sm:max-w-lg base class

* style(webui): set edit task dialog max width to 5xl

* chore: untrack kanban plan markdown files

* feat(webui): update kanban page layout to 2 columns and refine task activity UI

* fix(webui): constrain kanban column and board heights for vertical scrolling

* feat(kanban): unify task status transition into updateTask API and allow unconstrained human task transitions

* fix(webui): add optimistic updates to kanban drag-and-drop to eliminate flash

* refactor(webui): remove client-side search box from kanban header

* feat(kanban): redesign task dialog comments area and add attachment support

* refactor(webui): remove top status action bar from task info dialog

* fix(webui): narrow query cache predicate and add defensive guards for kanban drag optimistic update

* feat(kanban): add drag-and-drop task reordering with fractional indexing (#331)

* feat(kanban): add drag-and-drop task reordering with fractional indexing

* fix(kanban): improve card drop zones, snap indicators, and column highlight

* fix(kanban): enable card droppables only during active drag

* fix(kanban): refine hover styles and drop indicators for column boundaries

* fix(kanban): unify bottom drop indicator and fix top indicator clipping

* fix(kanban): ensure full column highlight and full coverage drop target

* minor change

* feat(kanban): allow agent tasks free drag-and-drop and enforce status change permissions (#332)

* refactor(kanban): rename task_type_agentic translation keys to task_type_agent

* feat(kanban): refactor task type enum to isAgentTask boolean (#333)

* refactor(kanban): remove phase 2 agent execution logic and streamline phase 1 kanban

* feat(kanban): add notifications and audit logging for kanban (#334)

* feat(kanban): redesign config area layout and add parent tasks multi-selector (#335)

* feat(webui): redesign kanban task dialog config area

* feat(kanban): simplify task dependencies with parent tasks multi-selector

* refactor(kanban): remove unused links routes and legacy dependency methods

* feat(kanban): connect assets and kanban tasks with many-to-many relationship (#336)

* feat(kanban): connect assets and kanban tasks with many-to-many relationship

* feat(kanban): improve asset picker layout, infinite scrolling, and breadcrumb icon styling

* fix(kanban): ensure asset picker scrollarea is scrollable with min-h-0 and shrink-0 flex styling

* fix(kanban): hide recently deleted in folder tree picker and adjust header padding

* fix(kanban): use lucide files icon instead of paperclip for linked assets

* feat(kanban): improve task deletion, goal sidebar interaction, and card styling (#337)

* feat(kanban): improve task deletion, goal sidebar interaction, and card styling

* feat(kanban): move agent task badge after priority and update to orange style

* feat(kanban): add status Compare-And-Swap (CAS) to prevent drag-and-drop race conditions (#338)

* feat(kanban): add status Compare-And-Swap (CAS) to prevent drag-and-drop race conditions

* style(kanban): rotate kanban icon 180 degrees in sidebar and top nav

* style(kanban): remove rotate-180 from SquareKanban icons

* feat(kanban): add unassigned goal record and fix all tasks count (#339)

* feat(kanban): add unassigned goal record and fix all tasks count

* feat(kanban): toggle task count with three-dot action button on goal card hover

* fix(ci): pin bun version to 1.3.14 across CI and Docker (#340)

* fix(webui): truncate goal name to max 2 lines in kanban sidebar (#341)
2026-08-23 10:28:56 +08:00
yiling 4c0fd29b7f Release v0.3.9 2026-08-18 18:42:59 +08:00
Yiling-J ffef67be8f feat(quota): move usage monitoring to team dashboard (#327) 2026-08-18 15:57:36 +08:00
Yiling-J 4d100bf542 docs(team-settings): add resource quotas documentation and update readme features (#326)
* docs(team-settings): add resource quotas documentation and update readme features

* fix(webui): correct sandbox filesystem description
2026-08-18 14:48:12 +08:00
Yiling-J 8a75d015a1 fix(quota): exclude agents from quota rules and usage records (#325)
* fix(quota): exclude agents from quota rules and usage records

* refactor(quota): remove agent_skill_call_count resource type and related logic

* chore(db): replace manual migration with prisma-generated migration
2026-08-18 11:56:03 +08:00
Yiling-J f806272c06 feat(settings): reorganize settings into personal, team, and AI sections (#324) 2026-08-18 08:35:23 +08:00
Yiling-J 4935eeff28 fix(webui): preserve selected chatbot agent preference on reload (#323) 2026-08-17 20:47:57 +08:00
Yiling-J eed0264b9c feat(quota): add 2-level database-backed resource quota system (#318)
* feat(quota): add database-backed resource quota system

* feat(webui): add resource quota management in team settings (#319)

* feat(webui): add resource quota settings in team management

* refactor(webui): update quotas list to full row layout and restrict skill/mcp to select list

* feat(quota): refactor quota system to 2-level rules and records

* fix(webui): fix overflow and scroll area in quota usage records dialog

* fix(webui): ensure quota records scroll area has explicit max height

* feat(webui): improve quota cards interaction and restrict editable fields in edit mode

* fix(quota): serialize initial records, validate merged updates, and reset on dimension changes (#320)

* feat(quota): replace network quota with agent tools quota (#321)

* feat(webui): show remaining time until next refresh in quota usage records

* fix(webui): rename bash quota resource to Agent Bash Calls

* refactor(quota): remove unused reserved field from quota records

* refactor(quota): remove quota rule cache (#322)
2026-08-17 20:24:05 +08:00
Yiling-J dd82daf65c feat(webui): use project members for asset comment mentions (#315)
* feat(webui): use project members for asset comment mentions

* refactor(project): remove legacy unused bots endpoint and props
2026-08-16 16:44:50 +08:00
Yiling-J 55d9596835 feat(authz): enforce project-aware roles for agent/skill/mcp permissions (#314)
* feat(authz): enforce project-aware roles for agent/skill/mcp permissions

Introduce a shared resolveEffectiveRole helper that mirrors AuthzService
precedence rules (projectMember.role override -> team role for team-scoped
members -> restricted), and route all agent/skill/mcp runtime permission
checks through it. Previously these checks used the raw teamMember.role,
which let project-only members execute team-level agents/skills/MCP tools
and ignored per-project role overrides.

Changes:
- authz: add resolveEffectiveRole(teamId, projectId, userId, db) and
  refactor hasPermission to use it (behavior-preserving)
- chat/asset/agent-activity: gate agent usage by the effective project role
- read_skill: enforce skill permission via effective role (projectId
  threaded from the agent session)
- mcp-service: checkPermission and buildAgentTools filter by effective
  role; un-permitted servers' tools are no longer advertised to the model
- agent activity: only advertise skills the user's effective role permits
- listProjectMembers: filter included agent bots by the requester's
  effective project role
- new GET /projects/:projectId/chat-agents API returning chat agents
  scoped to the project and the user's effective role; WebUI chat selector
  now uses it (settings keeps the team-level API)
- tests: effective-role resolver, chat/mention/MCP/skill project-role
  matrices, listProjectChatAgents, listProjectMembers filter, API route

* fix(agent): forward projectId to getAgentChatContextActivity in agentChat workflow

The agentChat workflow called getAgentChatContextActivity without passing
projectId from the task payload, so project-scoped members (scope:
'project') resolved a null effective role in the activity and were denied
with 'Insufficient role to use agent' even though the chat selector and
chat.ts both authorized them. Forward payload.projectId so the activity
enforces the user's effective project role, and assert the forwarding in
the workflow unit test (fails without the fix).
2026-08-16 15:44:45 +08:00
Yiling-J cb1c1c502b feat(agent): add permission controls for chat agents (#313)
* feat(agent): add permission controls for chat agents

* refactor(agent): extract shared agent permission helpers

Consolidate the duplicated role-hierarchy logic into
packages/core/src/agent/permissions.ts:

- getRoleLevel(): numeric level for a team role (fail closed at 0)
- getAgentRequiredLevel(): required level for an agent permission
  (defaults to reviewer/1)
- getAllowedAgentRoles(): inclusive role set for filtering

The typed Record over TeamMemberRole makes the mapping exhaustive,
so adding a new role fails compilation until all sites are updated.
Used by ChatService.startOrContinueChat, AssetService comment
mentions, getAgentChatContextActivity, AgentService.listAgents, and
TeamService.getTeamMembers, replacing four inline copies of the
hierarchy and the allowed-roles conditionals.

Also fix the API permission-denial test to mock HTTPException(403)
and assert a 403 response instead of a generic Error/500, matching
real authzService behavior.

* test(agent): fix flaky comment DAG tests by spacing ULID id generation

ULID ids have 1ms timestamp granularity; back-to-back comment creates
frequently land in the same millisecond, in which case Prisma ULIDs sort
by their random suffix instead of creation order. The DAG spine in
initializeAgentSessionActivity chains top-level comments by id, so a
shuffled order produces paths that omit preceding comments, making the
path-to-root assertions flaky (~80% of full-file runs locally).

Add a 2ms sleep between consecutive comment creates in the affected
tests, guaranteeing strictly increasing ULID timestamps. A 2ms delay is
sufficient because the next create always fires at least 2ms after the
previous ULID was generated. Production is unaffected: real comments
arrive seconds apart via separate requests.
2026-08-16 11:16:14 +08:00
yiling 6d4f62d6f6 Release v0.3.8 2026-08-15 20:35:30 +08:00
Yiling-J 43808216e6 fix(core): rename latest version child record on version stack rename (#312) 2026-08-15 16:18:11 +08:00
Yiling-J f66bb7af73 feat(version-stack): add manage versions dialog and version removal (#311)
* feat(version-stack): add manage versions dialog and version removal

* fix(webui): remove ellipsis and add pointer cursor to manage versions button

* fix(version-stack): handle symlink deduplication and name sync for share links

* refactor(version-stack): extract shared symlink dedup helper

The 'repoint first symlink per share folder, delete duplicates with
fileCount decrement' logic was triplicated across createVersionStack,
reparentAssets, and reparentFileToFile with subtle variations. Extract
it into dedupeSymlinksToTarget() in packages/core/src/asset/symlink.ts
and call it from all three sites (behavior unchanged), with a dedicated
test suite covering the edge cases.
2026-08-15 15:37:17 +08:00
Yiling-J ae86d56a7d feat(webui): improve AGENTS.md editor placeholder and read-only notice (#310)
* feat(webui): improve AGENTS.md editor placeholder and read-only notice

* docs: add AGENTS.md documentation under Shumai Agent Settings
2026-08-15 11:00:30 +08:00
Yiling-J 1cee103b1c feat(agent): add nested agents.md support across backend and webui (#309)
* feat(agent): add nested agents.md support across backend and webui

* fix(webui): update agentsmd route paths and unnest folder agentsmd route

* fix(agent): flush agents.md autosave on close and address review feedback

- Flush pending debounced AGENTS.md autosave on close/unmount so edits
  made within 750ms of navigating away are no longer silently lost
- Serialize autosaves through a promise chain so an older in-flight
  request can never overwrite newer content on the server
- Internationalize the hardcoded "Failed to save" and
  "Loading AGENTS.md..." strings (en + zh)
- Validate that AGENTS.md is only stored on folder/root assets in
  AssetService, preventing bogus virtual paths for file assets
- Cap updateAgentsMd content at 100k chars via Zod validation
- Remove unused getAgentsMd/updateAgentsMd response DTO schemas
- Drop unused teamId prop from AgentsMdEditor
- Add tests: non-folder asset rejection, oversized content 400,
  and agent-chat workflow assetId passthrough

* refactor(db): isolate AGENTS.md content in dedicated 1:1 AssetAgentMd table

* style(webui): unify top bar button hover styles and add wand icon to agentsmd button

* style(webui): update agentsmd button state colors and remove presence dot

* fix(webui): fix close button overflow and stabilize debounced autosave in agentsmd editor

* fix(webui): update debounce to 1s and await pending save before closing agentsmd editor

* feat(webui): add terminal AGENTS.md breadcrumb on agentsmd editor page

* fix(webui): use ScrollArea for markdown editor scrolling
2026-08-15 10:25:46 +08:00
Yiling-J 3c3b6880e4 feat(webui): replace legacy markdown editor with new lexical wysiwyg editor (#308)
* feat(webui): replace legacy markdown editor with new lexical wysiwyg editor

* refactor(webui): organize markdown editor files into components/markdown-editor folder
2026-08-14 16:27:14 +08:00
yiling 0b84402c83 Release v0.3.7 2026-08-14 14:47:18 +08:00
Yiling-J 61a61abc7c fix(webui): fix select field height and multi-select overflow/interaction issues (#307)
* fix(webui): standardize single-select custom field height

* fix(webui): fix multi-select badge overflow calculation and simplify direct edit
2026-08-14 14:35:17 +08:00
Yiling-J fc878775c2 feat(agent): support dynamic newOption in select and selectMulti metadata fields (#306)
* feat(webui): redesign select and multi-select metadata fields with search box and dynamic option creation

* fix(webui): stabilize select popover placement and preserve field visibility in store

* refactor(webui): enforce 2-row collapsed height and whitespace-pre-wrap on LongTextField

* feat(agent): support dynamic newOption in select and selectMulti metadata fields

* fix(metadata): address code review feedback on selectMulti item validation and WebUI option deduplication
2026-08-14 10:56:18 +08:00
Yiling-J 7acf736300 feat(webui): redesign select metadata fields and improve long text field widget (#305)
* feat(webui): redesign select and multi-select metadata fields with search box and dynamic option creation

* fix(webui): stabilize select popover placement and preserve field visibility in store

* refactor(webui): enforce 2-row collapsed height and whitespace-pre-wrap on LongTextField
2026-08-13 22:46:40 +08:00
Yiling-J 9d50301a43 feat(sandbox): default Network Sandbox to off and add settings toggle switch (#304) 2026-08-13 20:50:34 +08:00
Yiling-J 7f185ca23c feat(agent): type-safe CREATION_CONTEXT metadata on create_file/create_version (#303)
* feat(agent): type-safe CREATION_CONTEXT metadata on create_file/create_version

Build the create_file and create_version tool metadata parameter from the
project's CREATION_CONTEXT fields at harness creation time, instead of the
schemaless key-value map that required the agent to call list_autofill_fields
first.

- Thread projectId from the chat workflow into createAgentSession and build
  a strict, all-required (nullable) metadata schema via fieldsToTypeBoxSchema
  (additionalProperties: false, option IDs enforced via enum).
- Remove the list_autofill_fields tool and its activity case.
- Reject metadata keys that are not CREATION_CONTEXT fields of the target
  project with a clear non-retryable error telling the agent to omit metadata.
- Skip null metadata values when persisting (create_file/create_version and
  the autofill workflow).
- Switch the touched schemas from @sinclair/typebox 0.34 to typebox v1 to
  match the harness validator.

* refactor(agent): migrate remaining tools from @sinclair/typebox 0.34 to typebox v1

All agent tool schemas now use the same typebox v1 package as the harness
validator; drop the @sinclair/typebox 0.34 dependency from @shumai/agent.

* test(agent): reproduce null coercion in harness tool validation

The pi-ai harness (<=0.82.1) coerces null values in [string, null] unions to
'' during tool argument validation for typebox v1 schemas. A valid create_file
call with path: null + data: {...} therefore arrives at execute with path: ''
and fails with 'Provide exactly one of path or data'. Null metadata values
(the 'unknown' sentinel) are likewise turned into ''.

This test reproduces both failures. It is expected to fail until
@earendil-works/pi-ai is upgraded to >=0.84.0 (#7328), which preserves values
that already match a union arm.

* fix(agent): patch pi-ai 0.82.1 to preserve null in nullable union tool args

Apply the upstream fix for earendil-works/pi#7328 (PR #7373) via a bun
patch instead of upgrading pi-ai. coerceWithUnionSchema now returns the
original value when it already validates against any union member,
instead of coercing null in [string, null] unions into "".

Fixes the create_file false "Provide exactly one of path or data" error
when the model passes path: null with data. Reproduced by
packages/agent/src/reproduce-tool-null-coercion.test.ts, which now passes.

* fix(docker): copy bun patch dir before frozen-lockfile install

The pi-ai patchedDependencies entry makes bun install --frozen-lockfile
fail in the builder stage because patches/ was not present in the image
yet. Copy it alongside package.json/bun.lock so the patch applies.

* refactor(agent): simplify metadata guidance in system prompt and error message

Shorten the create_file/create_version metadata instructions in the system
prompt and reword the invalid-metadata-key error to not reference
CREATION_CONTEXT internals. Update the matching test assertion.
2026-08-13 20:06:09 +08:00
yiling 94582c9001 try fixing aliyun docker push 2026-08-13 15:06:44 +08:00
Yiling-J 41b73feeab feat(metadata): replace aiAutofill boolean with autofillSource enum (#302)
* feat(metadata): replace aiAutofill boolean with autofillSource enum

* fix(agent): validate creation-context metadata and make writes transactional

Address code review feedback on the autofillSource migration:

- Update the agent system prompt to reference the 'metadata' parameter of
  create_file/create_version instead of the removed 'context' parameter,
  which was being silently discarded by the activity
- Write metadata inside the caller's transaction via the new
  metadataService.updateAssetMetadataInTx, keeping metadata rows atomic
  with asset creation instead of opening a separate non-atomic transaction
- Reject metadata keys that are not defined CREATION_CONTEXT fields of the
  project with a non-retryable ApplicationFailure before creating the asset
- Remove dead agentContext handling from autofillAiActivity and its tests,
  and drop the unused ai_autofill i18n keys (paraglide recompiled)
- Derive the DTO autofillSource enum from the AutofillSource const instead
  of a hardcoded z.enum to prevent drift
2026-08-13 13:41:46 +08:00
yiling 96493a5493 Release v0.3.6 2026-08-12 14:56:54 +08:00
Yiling-J 93c593545d fix(i18n): update Chinese translation for dashboard to 仪表板 (#301) 2026-08-12 14:46:46 +08:00
Yiling-J 11758c23c0 docs(mcp): add MCP support documentation to README and docs (#300)
* docs(mcp): add MCP support documentation

* docs(readme): simplify MCP feature description

* docs(mcp): fix inaccuracies in MCP servers documentation

- Clarify that discovery runs on refresh, OAuth completion, or first
  tool call, not automatically at server creation
- Note that advanced settings (transport, auth, permission, direct
  tools) are configured in the edit dialog after creation
- Correct agent assignment UI description: switch toggle, not checkbox

* docs(mcp): explain proxy vs direct tool configuration

Add a dedicated section covering the three tool states (Off / Proxy /
Direct), what the mcp proxy tool does and why it exists, and when and
why to use direct tools, including the context-token trade-off.
2026-08-12 14:26:10 +08:00
Yiling-J 1cd94a77c6 feat(webui): direct canvas PDF rendering with selectable text (#299)
* feat(webui): render pdf pages via live canvas with selectable text

Replace the rasterize-to-PNG pipeline in the PDF viewer with direct
canvas rendering that tracks the current zoom, so text stays crisp when
zoomed in, and overlay a pdf.js TextLayer that makes text natively
selectable when not in draw mode.

- pdf-viewer: render pages onto a live canvas at a zoom-proportional
  scale (debounced, memory-capped) instead of a fixed 2x PNG snapshot
- pdf-viewer: add pdf.js TextLayer overlay per page, transformed in
  lockstep with the Konva stage so spans stay aligned while panning
  and zooming
- drawing-canvas: accept an optional live canvas element and force a
  layer redraw when it is swapped
- add text-layer.css with the minimal pdf.js text layer styles
- add e2e spec verifying text selection in view mode and that draw
  mode routes drags to the canvas

* fix(webui): show pdf text selection highlight above the page canvas

The pdf.js text layer was stacked below the opaque Konva page canvas, so
the native selection highlight was painted underneath it and invisible
(selection itself worked). Move the overlay above the canvas and gate its
pointer-events on draw mode: auto when not drawing (select text), none in
draw mode so drags reach the Konva stage below (draw markup).

Verified with screenshot pixel analysis: the selected region now renders
the highlight (blue) where it was pure grayscale before.

* fix(webui): transparent selection background for pdf text layer br elements

* fix(webui): stop pdf text selection over-selecting in empty space

The text layer container was user-selectable (user-select: auto), so when
a drag's caret moved into empty space Chromium targeted the container and
extended the selection to a container-content boundary, selecting across
rows (e.g. dragging from line 1 into the gap selected lines 1-2).

Make the container user-select: none while keeping the text spans
user-select: text, so the caret clamps to the nearest selectable text and
the selection stays put when dragging into empty space.

* fix(webui): deselect pdf text when clicking empty space

With user-select: none on the text layer container, Chromium no longer
clears the selection when clicking non-selectable areas. Clear it manually
on mousedown over the container or <br> (not a text span) so clicking
empty space between lines or outside text deselects, matching native
behavior.
2026-08-12 13:58:02 +08:00
Yiling-J 5ad3fdbf69 fix(webui): content-only pinch-zoom and two-finger pan in media viewers (#298)
* fix(webui): add content-only pinch-zoom and two-finger pan to media viewers

Intercept trackpad pinch (ctrl+wheel), touchscreen pinch (two touches),
and two-finger move inside the image, video, and PDF viewers so they
transform only the media content instead of triggering browser page
zoom (matching Frame.io behavior).

- New shared pan-zoom math (zoomAtPoint, fitScale, isZoomed) and a
  usePanZoomGestures hook using native non-passive wheel/touch listeners
  with touch-action: none on the media container.
- Plain wheel / two-finger scroll pans the content, but only once the
  user has zoomed in; drag-pan is gated the same way.
- Image and PDF viewers no longer reset zoom to fit on container resizes
  while the user has manually zoomed (matches the video viewer).
- DrawingCanvas ignores multi-touch moves so single-pointer pan/draw
  doesn't fight the pinch handler; the video viewer keeps play/pause on
  the container div to avoid double-toggling when the overlay is active.

Includes unit tests for the pan-zoom math.

* fix(webui): disable click-drag pan for pdf and video viewers

When zoomed, PDF and video previously panned on left-button (or
single-finger touch) drag via the shared DrawingCanvas. That conflicts
with left-click semantics: PDF wants the drag for text selection and
video reserves the click for play/pause.

Remove the gated onPan from both viewers so the Konva overlay stays
pointer-events:none when not drawing - clicks pass straight through
(video click-to-play now works cleanly at any zoom) - while panning
remains available via mouse wheel and two-finger gestures. Image keeps
drag-pan.
2026-08-12 10:54:42 +08:00
Yiling-J 851ae49c84 feat(mcp): support tool-level directTools array and 3-state UI configuration (#297)
* feat(mcp): support tool-level directTools array and 3-state UI configuration

* refactor(mcp): refine tool hint explanation and separate server instructions block

* style(mcp): display tool count in header title and split option hints into 3 lines

* style(mcp): update tools description paragraph and place bulk buttons on a separate row

* fix(mcp): enforce excludeTools in proxy path and align direct-tool counts

- Filter the per-agent tool registry by excludeTools at build time (DB cache
  and lazy-connect paths), so excluded tools are unreachable through the mcp
  proxy (call, search, list, describe) — matching pi-mcp-adapter where
  isToolAllowed gates both direct and gateway exposure.
- Add shared isDirectTool predicate (matches original or prefixed name) used
  by both buildDirectTools and the proxy description counts, so the
  advertised direct/proxy counts can no longer drift from actual
  registration; toolCount now reflects allowed tools only.
- Remove the legacy boolean directTools branch (no legacy data exists).
- Drop the now-unused mcp_excluded_tools_hint i18n key and regenerate
  Paraglide messages.
- Extend unit tests: excluded tools are not counted, listed, searched, or
  callable via the proxy; prefixed-name directTools configs count correctly.
2026-08-11 15:43:27 +08:00
Yiling-J 82aee9a291 fix(agent): resolve version stack name and size in list_assets (#296)
* fix(agent): resolve version stack name and size in list_assets

* fix(agent): resolve version stack to latest version in download_asset, analyze_image, and read_pdf_pages
2026-08-11 12:09:29 +08:00
Yiling-J 1b5cbf936a feat(mcp): add MCP server support with proxy tool and OAuth flow (#289)
* feat(mcp): add MCP server support with proxy tool and OAuth flow

Add URL-based MCP (Model Context Protocol) server support to the backend:

- DB: McpServer / AgentMcpServer / McpServerCredential models with
  typed JSON columns (auth config, cached tools, stored OAuth tokens,
  pending auth state) and a migration.
- Core (@shumai/core/src/mcp): DB-backed credential store, OAuth
  client provider (authorization_code + client_credentials) with a
  Hono-hosted redirect callback, connection lifecycle manager
  (Streamable HTTP with SSE fallback, lazy connect, 401 -> needs_auth),
  JSON Schema -> AgentTool parameter conversion, in-memory tool registry
  with ranked search, the single 'mcp' proxy AgentTool (search /
  describe / list / call / connect / status / auth-start), per-server
  opt-in direct tools ({server}_{tool}), and McpService (CRUD,
  discovery, OAuth, per-agent assignment via AgentMcpServer, and
  permission gating on tool execution mirroring skills).
- Agent: chat agents receive the 'mcp' proxy tool (plus direct tools
  for opted-in servers) built from their assigned, enabled servers.
- API: /teams/:teamId/mcp/servers CRUD, tools refresh/list, auth
  start/complete/status/remove, test, permission, and the public
  OAuth callback route; Admin authz via new ResourceType.McpServer;
  audit logging.
- DTOs: zod schemas + types for servers, tools, auth, and per-agent
  mcpServerIds.
- Tests: DB store, schema conversion, registry/search, service
  integration against a real in-process MCP server (v2
  @modelcontextprotocol/server), permission gating, rename
  invalidation, direct tools, per-agent assignment, API route tests,
  and workflow E2E (local + temporal) for proxy and direct modes.

* fix(mcp): persist OAuth discovery snapshot and stamp SEP-2352 issuer

The callback leg of the OAuth flow failed with
AuthorizationServerMismatchError ('discoveryState was not available on
the callback leg') because McpDbStore.savePendingAuth overwrote the
entire pendingAuth JSON column, clobbering the discoverySnapshot that
the provider's saveDiscoveryState() had stored inside it.

- McpDbStore.savePendingAuth now preserves an in-flight discovery
  snapshot so the callback leg can satisfy the SEP-2352 authorization-
  server issuer check.
- McpOauthProvider now round-trips the issuer stamp derived from the
  discovery snapshot: saveClientInformation/saveTokens persist it,
  clientInformation()/tokens() return it, and tokens() backfills a
  missing stamp for pre-existing credentials (removes the
  'stored OAuth credential has no issuer stamp' warning).
- Regression tests: savePendingAuth keeps the snapshot; the provider
  stamps/round-trips the issuer on both legs.

* fix(mcp): backfill SEP-2352 issuer stamp on stale OAuth client info

clientInformation() returned stored client info without an issuer field
when it had been dynamically registered before the stamping fix, so the
SDK logged 'stored OAuth credential has no issuer stamp' on every read.
Now the stored branch backfills the issuer from the discovery snapshot
(persisting it) exactly like the tokens() backfill.

* feat(webui): add MCP server configuration and agent assignment UI (#290)

* feat(webui): add MCP server configuration and agent assignment UI

* fix(webui): auto-detect auth for unconfigured MCP servers and show connect button

* fix(mcp): auto-generate state in mcp-oauth-provider when missing in DB

* fix(mcp): persist OAuth discovery snapshot and stamp SEP-2352 issuer

The callback leg of the OAuth flow failed with
AuthorizationServerMismatchError ('discoveryState was not available on
the callback leg') because McpDbStore.savePendingAuth overwrote the
entire pendingAuth JSON column, clobbering the discoverySnapshot that
the provider's saveDiscoveryState() had stored inside it.

- McpDbStore.savePendingAuth now preserves an in-flight discovery
  snapshot so the callback leg can satisfy the SEP-2352 authorization-
  server issuer check.
- McpOauthProvider now round-trips the issuer stamp derived from the
  discovery snapshot: saveClientInformation/saveTokens persist it,
  clientInformation()/tokens() return it, and tokens() backfills a
  missing stamp for pre-existing credentials (removes the
  'stored OAuth credential has no issuer stamp' warning).
- Regression tests: savePendingAuth keeps the snapshot; the provider
  stamps/round-trips the issuer on both legs.

* fix(mcp): backfill SEP-2352 issuer stamp on stale OAuth client info

clientInformation() returned stored client info without an issuer field
when it had been dynamically registered before the stamping fix, so the
SDK logged 'stored OAuth credential has no issuer stamp' on every read.
Now the stored branch backfills the issuer from the discovery snapshot
(persisting it) exactly like the tokens() backfill.

* fix(mcp): attach McpOauthProvider for auto-detected OAuth servers and discover tools on auth completion

* fix(webui): fix flex min-h-0 and max-h scrolling on MCP tools dialog

* fix(webui): set explicit flex height on McpToolsDialog for active scrolling

* feat(webui): make MCP server cards clickable to edit and widen server config dialog

* feat(mcp): agent-level server enablement and auto-detected server metadata (#291)

* feat(mcp): agent-level server enablement and auto-detected server metadata

- Remove the server-level `enabled` column from mcp_servers; enable/disable
  now happens per-agent via the AgentMcpServer join table (mirrors skills).
- Drop the unique (teamId, name) constraint so duplicate server names are allowed.
- Add a `description` column, auto-filled from client.getServerVersion() on
  connect; the server name is auto-filled from the reported title (fallback name)
  with a URL-derived placeholder until first connect.
- Remove manual name input: the create dialog is URL-only, and the edit dialog
  shows the auto-detected name/description read-only.
- Replace the include/exclude raw-text inputs with the tool list in the edit
  dialog, managing only excludeTools; remove includeTools support and the
  separate McpToolsDialog component.
- Sanitize server-reported names into safe direct-tool prefixes (spaces/punctuation
  become underscores) and use the same sanitization in the proxy resolver.

* fix(mcp): give the edit-dialog tool list a definite height

The Shadcn ScrollArea viewport is h-full, which requires a definite height
on the root. Using max-h-64 left the viewport at auto height, so the root
clipped the list at 256px without engaging its own scrollbar — tools past
the cutoff were unreachable. Use a fixed h-64 container (same pattern as
move-copy-dialog) so the inner scroll area scrolls independently of the
dialog's outer scroll.

* refactor(mcp): fixed header/footer with scrollable content in server config dialog

Mirror the skill config dialog layout: the edit dialog now keeps the header
and footer fixed and scrolls only the content area (ScrollArea flex-1
min-h-0 inside an h-[85vh] flex column). The tools list no longer has its
own nested ScrollArea — it flows inside the content-level scroll, so all
tools are reachable without a nested-scroll conflict. The create dialog
stays compact (URL-only) like the skill add dialog.

Verified headlessly that max-height-based ScrollArea roots do not engage
scrolling (viewport height resolves to auto), which is why the previous
nested list clipped; the flex-based definite-height pattern scrolls.

* feat(mcp): make the endpoint URL immutable after creation

Editing a server's URL effectively points it at a different server, and the
create flow is URL-only anyway — so the edit dialog no longer allows changing
it (delete + re-add covers endpoint changes). The URL is displayed read-only
next to the auto-detected name/description, and `url` was removed from the
update DTO and service; auth/transport changes still invalidate credentials
and cached tools.

* refactor(mcp): match MCP server cards to the skill card layout

The settings list cards now share the skill card structure: row 1 is the
server name (with direct-mode/transport badges) plus the three-dot menu,
row 2 is the description (falling back to 'No description provided') with
the endpoint URL and last error as small mono lines, and row 3 holds the
connection-status badge and updated date on the left with the permission
selector and the connect button at the right end.

* fix(mcp): stop card menu clicks from opening the edit dialog

The three-dot menu is portaled, so its item clicks bubble through React's
synthetic events to the card's onClick, which opened the edit dialog before
the delete confirmation appeared. Add e.stopPropagation() to every menu
item (matching the skill card pattern).

* fix(mcp): stop Refresh Tools from submitting/closing the config dialog

The Refresh Tools button lived inside the <form> and, like all buttons
without an explicit type, defaulted to type="submit" — clicking it ran the
form submit (save + close) instead of just refreshing. Set type="button".

Also per UX: while refreshing, the button is disabled with a spinning icon,
the per-tool enable/disable switches are disabled, and the success toast is
removed — the button reverting to its idle state is the success signal
(keep the error toast for failures).

* test(mcp): provide explicit redirectUri in McpOauthProvider test helper

* fix(mcp): scope tool registry to agent-assigned servers

The MCP tool registry was a process-global singleton keyed by server id,
so a chat agent could search, describe, and even call tools belonging to
MCP servers that were not assigned to it (e.g. disabled or unassigned
servers), as long as their metadata had been discovered at some point in
the process. This mirrors the disabled-skill bug: the read path never
checked per-agent enablement.

Replace the singleton with a fresh McpToolRegistry built per
buildAgentTools call and warmed from the persisted McpServer.tools DB
cache. Because the registry only ever contains the agent's assigned
servers, unassigned/disabled servers can neither be suggested, searched,
described, nor executed. Live discovery (lazy connect / connect action)
writes into the per-agent registry via ensureConnected(serverId,
registry?).

Adds test-first coverage: suggestions, search, describe and tool-call
leaks across an unassigned same-team server, staleness after
unassignment, and direct-tools scoping.

* feat(mcp): capture and surface server instructions + server-level refresh (#293)

* feat(mcp): capture and surface server instructions

- Add McpServer.instructions column, populated from getInstructions() at
  connect time (legacy initialize + modern discover results)
- Surface instructions at three levels like pi-mcp-adapter: truncated
  snippet in the mcp proxy tool description, preview in server listings,
  and full text via mcp({ instructions: "name" })
- Fix misleading mcp({ server, connect }) usage line to mcp({ connect })
- Share one renderServerListing helper across list and connect modes
- Expose instructions in McpServerInfo DTO and WebUI config card
- Test server supports instructions; service + API tests updated

* refactor(mcp): server-level refresh endpoint, drop agent connect mode

- Replace POST /mcp/servers/:id/tools/refresh with POST /mcp/servers/:id/refresh
  returning the refreshed McpServerInfo (server-level, not tools-level)
- Add McpService.refreshServer(): force-close the connection, re-discover and
  persist tools, instructions, name/description and status; used by the refresh
  endpoint, Test Connection, and post-OAuth completion (replacing discoverTools)
- Remove discoverTools entirely - refreshServer is the single discovery entry
  point (testServer and completeAuth route through it)
- Remove refreshTools from UpdateMcpServerRequest/PATCH (dead param)
- Remove mcp({ connect: "name" }) from the agent proxy tool: lazy tool calls
  still auto-connect, so agents are unaffected
- WebUI: remove the dialog 'Refresh Tools' button and create-mode background
  auto-refresh; add a server-level Refresh button at the left end of the edit
  dialog footer; i18n mcp_refresh_server (+ success message)

* feat(mcp): add in-flight request tracking and idle connection cleanup (#294)

* feat(mcp): add in-flight request tracking and idle connection cleanup

* feat(mcp): add background idle cleanup timer to McpService

* feat(mcp): update default background idle cleanup check interval to 30s

* feat(webui): improve MCP server card footer, instructions, and refresh dialog freeze (#295)

* feat(webui): improve MCP server list card, instructions dialog, and refresh freeze UI

* feat(webui): refine MCP card action menu items

* docs(webui): update direct tools mode description in i18n messages

* style(webui): refine Direct Tools Mode layout in MCP server config dialog

* feat(webui): remove tool search box from MCP server config dialog

* fix(mcp): make in-flight idle tracking test deterministic

The 'tracks in-flight requests and safely prunes idle connections' test
relied on a wall-clock sleep (10ms) to guess when the tool handler had
started executing on the server. On slow/loaded CI runners the HTTP round
trip through the real MCP client/server stack can exceed that window, so
resolveSlowTool() fired the no-op placeholder, the gated handler never
completed, and callPromise hung until the 5000ms test timeout.

The handler now signals via a deferred promise when it actually starts,
and the test awaits that signal (racing it against the call promise to
surface early failures) before asserting in-flight state and releasing
the gate. Also gives the test an explicit 10s timeout.
2026-08-11 11:01:38 +08:00
Yiling-J 1daeaf51ef fix(agent): prevent agents from accessing disabled skills (#292)
Disabling a skill in the agent config dialog only removed it from the
agent_skills join table, but the chat flow still advertised ALL team
skills to the model in the <available_skills> system prompt section and
the read_skill tool never checked per-agent enablement.

- getAgentChatContextActivity / getAgentAutofillContextActivity now only
  return skills explicitly enabled for the agent (agent_skills), and
  expose enabledSkillIds in the execution context.
- createReadSkillTool accepts enabledSkillIds and rejects read_skill
  calls for skills not enabled for the agent, even if the model knows
  the skill id from earlier conversation history.
- Added unit tests for context filtering (chat + autofill), tool-level
  enforcement, and the zero-enabled-skills case.
2026-08-10 17:33:40 +08:00
yiling 49ef48a74a Release v0.3.5 2026-08-09 20:58:35 +08:00
Yiling-J a680fccb12 fix(webui): enable rename and delete actions in file detail top bar breadcrumb (#288)
* fix(webui): enable rename and delete actions in file detail top bar breadcrumb

* fix(webui): select only base file name when renaming from file detail breadcrumb
2026-08-09 20:49:55 +08:00
Yiling-J e67552d8bd fix(webui): batch download no longer flashes a tab per file (#287)
startDownload() used <a target="_blank" download> anchors, which made
Chrome open a new tab for every file that then auto-closed as soon as the
download started (Content-Disposition: attachment). Replace with hidden
iframes: downloads start in the background without opening tabs, and a
failed/expired link renders inside the hidden iframe instead of
navigating the SPA tab away.
2026-08-09 17:09:01 +08:00
Yiling-J 8080acfb2e fix: use renamed asset name in download Content-Disposition (#286)
* fix(core): use renamed asset name in download Content-Disposition

Downloads of renamed assets (e.g. test.png renamed to foo.png) previously
saved under the storage-key basename because the presigned URLs / local
file handler only set Content-Disposition: attachment without a filename,
and the HTML download attribute is ignored for cross-origin URLs.

- Add buildContentDisposition() helper that emits a sanitized
  'attachment; filename=...; filename*=UTF-8...' header (RFC 5987) so
  non-ASCII names survive.
- Thread an optional filename through S3Service.presign():
  * S3 backend passes it via contentDisposition (response-content-disposition)
  * Local backend carries it as a ?filename= query param consumed by the
    /files serveStatic onFound handler
- getDownloadLinks / getDownloadUrl now pass the renamed asset name from
  the DB, so all download flows (file browser, viewers, breadcrumb, share)
  save files under the current asset name.

* fix(core): keep Content-Disposition header ASCII for non-ASCII names

Bun's Headers API rejects header values containing non-ASCII bytes, so a
download of a renamed file with a non-ASCII name (e.g. 幻境边界.pptx) threw
'TypeError: Header Content-Disposition has invalid value' on the local
storage backend.

Per RFC 5987, non-ASCII names belong only in the percent-encoded
filename* parameter. buildContentDisposition now emits the quoted
filename="..." fallback only when the name is pure ASCII; otherwise the
header carries just 'attachment; filename*=UTF-8''...' (all-ASCII, accepted
by Bun/Node Headers and all modern browsers).
2026-08-09 16:39:15 +08:00
Yiling-J dbd30a815f fix(webui): exclude file extension when selecting file name during inline rename (#285) 2026-08-09 16:06:44 +08:00
Yiling-J 442568de00 fix(webui): resolve upload card freeze for unsupported files (#284) 2026-08-09 15:16:41 +08:00
yiling d15fc5c6be update doc 2026-08-09 14:49:07 +08:00
Yiling-J aa6d5ed626 feat(transcode): add Gotenberg support for Office, HTML, CSV, and Markdown PDF proxies (#283)
* feat(transcode): add Gotenberg support for Office, HTML, CSV, and Markdown PDF proxies

* fix(transcode): use Gotenberg chromium markdown endpoint with index.html wrapper for markdown conversion

* test(transcode): add complete unit test coverage for HTML, CSV landscape/portrait, TXT, and Gotenberg fallback branches

* fix(gotenberg): force .md extension for Gotenberg markdown conversion endpoint compatibility

* refactor(gotenberg): standardize basic auth environment variables on GOTENBERG_BASIC_AUTH_USERNAME and GOTENBERG_BASIC_AUTH_PASSWORD

* test(e2e): add real Gotenberg testcontainers workflow E2E test for docx, pptx, and xlsx

* docs: add Gotenberg document PDF conversion documentation and update features in README

* docs(gotenberg): add Docker quickstart commands and remove obsolete GOTENBERG_USERNAME note
2026-08-09 14:44:13 +08:00
yiling 283d28bed9 Release v0.3.4 2026-08-08 20:15:25 +08:00
Yiling-J 315cacd474 Enhance README with new features and capabilities
Added new features including customizable watermark for shared links and support for various file formats.
2026-08-08 16:25:48 +08:00
Yiling-J 44ab1e7023 Add wide file format support to README 2026-08-08 16:19:09 +08:00
yiling beef4e9963 update readme 2026-08-08 16:06:25 +08:00
Yiling-J 990f68fb3b docs(agent): clarify create_file/create_version context param guidance (#282) 2026-08-08 15:41:22 +08:00
Yiling-J ee4933a4f8 feat(transcode): update preview thumbnail resolution to 300p with max length constraint (#281)
* feat(transcode): update preview thumbnail resolution to 300p with max length constraint

* fix(transcode): address code review feedback on preview thumbnail transcoding
2026-08-08 15:17:51 +08:00
Yiling-J c91867b8eb chore: split e2e scripts into app and webui targets (#280)
Split the monolithic test:e2e script into:

- test:e2e:app: fullstack web app e2e (playwright --project=app-chromium)
- test:e2e:webui: harness UI integration tests
  (E2E_SKIP_APP_SERVER=true --project=harness-chromium)

Remove the now-unused test:e2e:ui and test:e2e:report scripts, and update
the AGENTS.md submission rules and e2e README to reference the new
commands.
2026-08-08 13:20:52 +08:00
Yiling-J 8608ee027a test(e2e): stabilize watermark share spec on Firefox (#279)
Two issues made the watermarked share-link spec flaky on Firefox (and
silently mis-typed on every browser):

1. test.use inside a for loop leaks the last iteration's value to all
   tests: both the 'image' and 'video' cases were actually running the
   video flow. Scope each test.use inside a test.describe block.

2. Selecting the file by clicking the card body raced with the preview
   area re-rendering (video sprite scrubber hover) and the Radix menu
   exit animation, which could swallow the click on Firefox. Select via
   the card checkbox instead, and wait for the menu to fully unmount
   after Escape before the next interaction.

Verified stable: 6/6 on Firefox, 2/2 on Chromium, 2/2 on WebKit.
2026-08-08 13:11:44 +08:00
Yiling-J 394ddc8db4 docs(share-links): document allow download and lazy watermark settings (#278)
Document the two new share link security settings:

- Allow Download: hides all download affordances on the public pages and
  rejects the download endpoint with 403 while keeping previews available.
- Watermark: per-share-link lazy watermarking — transcodes are only
  triggered when the watermark is enabled on a share link (and again for
  files added later), so Shumai never stores watermark copies for files
  that are not shared through a watermarked link, saving storage.
2026-08-08 11:51:39 +08:00
Yiling-J 83455aeaea test(e2e): cover watermarked download-disabled share links for image and video (#277)
Add web app e2e coverage for the frequently-combined watermark +
download-disabled share link configuration. For both watermarkable media
types (image and video) the test asserts:

- no download affordance on the public share list page (card menu,
  selection bar) and the public file detail page (viewer control bar,
  top-nav file dropdown; video also has no resolution submenu)
- the proxy loaded in the detail page is the watermarked version
  (-watermark- S3 keys) and no original transcode key is requested
- the download-url endpoint rejects guest download attempts with 403

Extends the e2e share helpers with apiUpdateShare, apiEnableShareWatermark
and apiPublicDownloadUrl, and documents the new cases in the e2e README.
2026-08-08 11:45:06 +08:00
Yiling-J 707c091c9b fix(webui): persist project sorting and prevent full page flash (#276) 2026-08-08 10:37:45 +08:00
Yiling-J d3f5892dd2 feat(share): add allow download config to share links (#275)
* feat(share): add allow download config to share links

* fix(share): hide download in public share list page when disabled
2026-08-08 10:25:02 +08:00
Yiling-J 70b6c33204 fix(share): resolve symlinks for download URLs and enable card download action (#274) 2026-08-07 23:24:24 +08:00
Yiling-J 624a3a6a54 feat(webui): remove original-file display fallbacks, use proxies only (#273)
* feat(webui): remove original-file display fallbacks, use proxies only

WebUI now never uses the raw original file for display. All viewers
(image, video, compare, pdf) render exclusively from transcoded proxies;
when no proxy exists the viewer shows an unavailable placeholder instead
of falling back to media.original.

- getBestTranscode: drop the isRaw fallback candidates
- video-viewer / compare-video-pane: remove the synthetic 'Original'
  resolution entry and the original.downloadUrl hasMedia gate
- image-viewer / compare-image-pane: remove original.downloadUrl default
- pdf-viewer: require pdfTranscode.url (no original fallback)
- download menus (video-control-bar, breadcrumb-nav): use
  media.original.key for the 'Original' download option instead of the
  isRaw transcode marker entry

Backend:
- transcode-video workflow no longer pushes the isRaw:true marker entry
  into videoTranscodes (it pointed at the original file key)
- remove media.original.downloadUrl from the DTO, asset service mapping,
  MediaInfo DB type, and transcode workflows/activities (it was only
  consumed by the removed display fallbacks; downloads already use key
  via the download-url endpoints)

Tests/fixtures updated; docs updated to state the proxy-only display
policy.

* refactor: remove isRaw field via data migration, clean legacy media JSON

Add a Prisma data migration that cleans legacy media JSONB on both
assets and watermark_files:
- drop the raw-original marker entries (isRaw: true) from
  videoTranscodes / imageTranscodes — they pointed at the original file
  key and were only used by the removed display fallbacks / download
  menus, which now use media.original.key directly
- strip the isRaw field from remaining transcode entries
- drop original.downloadUrl (removed from the AssetInfo DTO)

The migration is generated via prisma migrate dev --create-only and
applied automatically by migrate deploy in production. It is guarded by
a test (packages/db/src/clean-media-migration.test.ts) that seeds legacy
media JSON, runs the migration SQL, and asserts the transform on both
tables.

With the data cleaned, remove the isRaw field entirely from the codebase:
- DTO schemas + ImageTranscode/VideoTranscode interfaces
- PrismaJson MediaInfo transcode types
- watermark activity isRaw skip (and its test), watermark proxy mapping,
  agent-embedding transcode selection, webui transcode filters, and all
  test fixtures

AGENTS.md: clarify that the no-manual-migration rule applies to DDL;
data migrations (pure SQL transforms, no schema change) are allowed
inside a --create-only generated migration and must be tested.
2026-08-07 22:40:06 +08:00
Yiling-J 03aea2cb36 feat(sharelink): add sharelink watermark support (#270)
* feat(sharelink): add sharelink watermark support

* fix(sharelink): harden watermark feature against races, crashes, and tenant leaks

Addresses review findings on the sharelink watermark feature:

- fix(watermark): read back sharelink via transaction client so the
  updateShareLinkWatermark response reflects the just-committed state
  (global-client reads on a pooled connection miss uncommitted changes)
- fix(watermark): use prisma upsert on the config hash instead of
  find-then-create to avoid P2002 races on concurrent enables
- fix(watermark): resolve nested symlinks when walking the share tree and
  batch the walk level-by-level instead of one query per node
- fix(watermark): keep watermark tasks in flight from being purged by
  orphan-config GC (avoids FK violations in completing activities)
- fix(transcode): re-transcode stale 'processing' watermark rows instead
  of silently skipping (crash recovery); downscale embedded block images;
  use pino structured logging; drop unused any casts
- fix(api): scope watermark-template list/create to the caller's teams,
  reject teamless template creation, and make teamless templates
  read-only; validate watermark config required when enabling (400);
  map sharelink-not-found to 404
- fix(api): resolve symlink target ids once in public share children
  endpoint instead of twice per item
- refactor(db): dedicated WatermarkFileStatus enum (migration included)
- test: activity unit tests (init crash recovery, image + video transcode
  paths), concurrent upsert, nested-symlink resolution, API scoping and
  validation, e2e video watermark path

* refactor(transcode): move sharp usage out of watermark activity into transcodeService

The transcode package does not declare sharp as a dependency (only
@shumai/core does), so importing it directly in the watermark activity
broke CI typecheck for the transcode package.

- add transcodeService.renderSvgToPng, downscaleImageToPng and
  compositeOverlayToWebpFile encapsulating the sharp logic
- watermark activity now calls these methods instead of importing sharp
- activity tests mock the new methods (no sharp/real fixture needed)
- add unit tests for the new transcodeService helpers

* feat(watermark): restrict watermark transcode to existing image and video transcodes

* refactor(transcode): reuse transcodeVideo in watermark activity

* refactor(watermark): use Bun.hash instead of node crypto for watermark config hash

* refactor(watermark): move computeWatermarkConfigHash from dtos to core watermark-hash module

* refactor(api): delegate watermark DB queries from public-share route to watermarkService

* refactor(share): replace dynamic watermarkService import with static import

* feat(watermark): add waitForWatermarkFileActivity for in-flight watermark transcoding tasks

* refactor(asset): replace dynamic watermarkService import with static import

* test(watermark): harden purgeOrphanWatermarkConfigs coverage

Replace the single happy-path GC test with a dedicated suite covering:

- orphan config with proxies: purged, watermarkFiles removed, all four
  proxy keys deleted from S3 while the original key is preserved
- config still referenced by a share link is not purged
- config with pending/processing transcode_watermark tasks is not purged
  (in-flight guard), but completed tasks do not block purging
- pending tasks of other types (transcode_video) do not protect a config
- an S3 delete failure is non-fatal: remaining keys still deleted and the
  config is still purged
- mixed run: only the orphan config is purged while a referenced one
  survives (exact count assertion)

* feat(webui): add sharelink watermark editor and sidebar controls

* style(webui): enlarge watermark editor dialog and allocate 2/3 width to preview column

* fix(webui): override sm:max-w-lg in DialogContent to allow full 1400px width

* fix(webui): stop block click propagation and remove preview mode toggles

* fix(webui): store watermark block size as fraction of canvas width

The editor stored block.size in pixels (slider 10-120px, preview
fontSize: `${block.size}px`) while the SVG generator
(generateWatermarkSvg) interprets size as a fraction (0..1) of canvas
width. A 36px block therefore rendered as a ~36x-canvas glyph covering
the entire image.

- Keep backend fraction semantics (canvasWidth * size) so watermarks
  scale proportionally with output resolution across proxies
- Editor: defaults (text 5%, image 15%), slider ranges (1-12% / 2-50%)
  and number input now work in percent, storing a fraction
- Preview: scales blocks by the measured canvas width so WYSIWYG
- DTO schema: size constrained to (0..1) to enforce the contract
- Update DTO/editor tests to fraction sizes

* feat(webui): add single-row aspect ratio selector and 5 predefined background colors to watermark editor preview

* feat(webui): update aspect ratio to multi-toggle group and enable dot-grid pattern for all background colors

* fix(webui): update background swatches to distinct colors and share PRESET_BACKGROUND_OPTIONS array

* fix(webui): hide redundant absolute close button on watermark editor dialog header

* fix(transcode): skip raw video transcode when generating watermark proxies

The raw marker entry (isRaw: true) in videoTranscodes points at the
original source file and is only used to offer the 'Original' playback
option. It is not a transcoded proxy, so watermarking it produced a
redundant full-resolution transcode (the most expensive pass) plus an
unneeded S3 upload.

Skip entries with isRaw: true in transcodeWatermarkMediaActivity, and
cover the behavior with a unit regression test plus an e2e assertion
that exactly one watermark proxy is produced for a video asset.

* feat(webui): replace watermark image asset ID with 1MB file uploader

* fix(webui): correct watermark editor preview block sizing

The preview canvas width was measured in a useEffect([open]) that ran
before the Radix Dialog had mounted its content, so canvasRef.current was
still null, canvasWidthPx stayed 0, and every block silently fell back to
the hardcoded 640px width (block.size * (canvasWidthPx || 640)). A 100%
size therefore rendered at ~640px on an ~876px canvas (~72%), making the
preview smaller than the real watermarked output for both image and text
blocks.

- Measure the canvas via a ref callback (fires exactly when the node
  mounts, regardless of dialog mount timing) and keep a ResizeObserver
  attached for aspect-ratio/window changes.
- Use clientWidth (padding-box width) instead of getBoundingClientRect(),
  which includes the dialog's zoom-in-95 animation transform.
- Drop max-w-full/max-h-full on the preview <img> so logos scale up to
  the block size like the backend SVG rendering does, instead of being
  capped at their natural pixel size.

* fix(webui): keep watermark editor preview aspect ratio and restore config scroll

- Compute the preview canvas size with a JS contain-fit (ResizeObserver on the
  frame) instead of relying on CSS aspect-ratio + w-full/max-h-full, which
  broke the selected ratio on wide-and-short (or tall-and-narrow) windows.
- Add min-h-0 to the config ScrollArea so it shrinks to the column's remaining
  height instead of growing to its content height, restoring the scroll range.

* fix(webui): remove toast notification on template load

* fix(share): serve per-file watermark proxies in public share APIs

Stop gating watermark replacement on the share-link-wide watermarkStatus.
Public share endpoints now resolve each asset's own completed watermark
proxy and:

- replace videoTranscodes/imageTranscodes with the watermarked entries
  when the watermark file is completed;
- empty those arrays when no completed proxy exists yet (still
  transcoding or failed) so original, unwatermarked media is never
  exposed while a newly added file is being processed;
- leave non-video/image media (pdf, audio, ...) untouched, since they
  never receive watermark transcodes.

This removes the previous behavior where adding a file to a ready
watermark share flipped the whole share link to processing and served
original media for every file until the new transcode finished.

Adds API tests for detail/children endpoints (ready, in-flight, pdf, and
watermark-disabled cases) and a workflow E2E test for adding an asset to
an already-ready watermark sharelink.
2026-08-07 21:36:20 +08:00
yiling 0a31659588 Release v0.3.3 2026-08-05 19:41:02 +08:00
Yiling-J 39a66dc569 Merge pull request #269 from shumaiOne/disable-project-member-team-role-dropdown
feat(webui): disable role dropdown for project-scoped members in team view
2026-08-05 19:06:28 +08:00
yiling 2a27e19b15 style(webui): expand members dialog max width to sm:max-w-xl 2026-08-05 18:54:51 +08:00
yiling f306229b21 style(webui): increase members dialog max width 2026-08-05 18:53:58 +08:00
yiling f5786f742b feat(webui): disable role dropdown for project-scoped members in team view 2026-08-05 18:50:55 +08:00
Yiling-J fe7e541585 Merge pull request #268 from shumaiOne/feat/e2e-member-permissions
test(e2e): add member permission change tests
2026-08-05 18:39:09 +08:00
yiling 47ecbdff6a fix(e2e): resolve lint rule for Playwright baseURL option 2026-08-05 18:33:10 +08:00
yiling 2dc0f08725 chore(e2e): default to chromium locally, run all browsers on CI 2026-08-05 18:28:46 +08:00
yiling e76ed19013 test(e2e): add member permission change tests 2026-08-05 17:51:27 +08:00
Yiling-J b7d3e32fb9 Merge pull request #267 from shumaiOne/feat/project-members-team-scope
feat(project): include team-scoped members in project member list and add 3-section dialog layout
2026-08-05 17:23:09 +08:00
yiling 94bda76c56 refactor(project): remove unnecessary explicit any cast in updateMemberRole 2026-08-05 17:14:00 +08:00
yiling 7586b8a44a feat(project): display flat member list for non-owners in members dialog 2026-08-05 16:52:16 +08:00
yiling d9a6734527 feat(project): include team-scoped members in project member list and add 3-section dialog layout 2026-08-05 16:39:19 +08:00
yiling 72aad56560 feat(project): include team-scoped members in project member list and refine dialog copy 2026-08-05 16:15:27 +08:00
Yiling-J ffeccaa514 Merge pull request #266 from shumaiOne/fix/field-reorder-dnd-kit
fix(webui): persist field order on drag and drop
2026-08-05 16:01:55 +08:00
yiling d73f7f81a1 fix(webui): persist field order on drag and drop
The handleDragEnd handlers in the Manage Fields dialog and Fields
dropdown guarded reordering on source.id !== target.id. With dnd-kit
react's OptimisticSortingPlugin (enabled by default), the drop target
always resolves to the dragged item itself, so the guard was never true
and the order API was never called.

Detect moves via the sortable-specific index/initialIndex properties on
the source instead, and reorder the rendered (grouped/search-filtered)
subset before merging back into the full field list. All field groups are
now reorderable in the dialog.
2026-08-05 15:52:58 +08:00
Yiling-J 1104ec36cc Merge pull request #265 from shumaiOne/fix/custom-field-options-and-placeholder
feat(webui): render select options in field creation mode and pick random option color
2026-08-05 15:28:56 +08:00
yiling ac5970c03e docs(webui): update field description placeholder text 2026-08-05 14:50:52 +08:00
yiling b568eac77d feat(webui): render select options in field creation mode and pick random option color 2026-08-05 14:44:30 +08:00
yiling bb9c53adad feat(agent): clarify create_file tool usage and context hint instructions 2026-08-05 12:01:04 +08:00
Yiling-J 29161f3a1a Merge pull request #264 from shumaiOne/feat/autofill-context
feat(agent): propagate autofill context from chat to autofill workflow
2026-08-05 11:25:04 +08:00
yiling b806b0e2ba refactor(agent): drop field/option ids from list_autofill_fields results 2026-08-05 11:02:25 +08:00
yiling 033652cde3 feat(agent): propagate autofill context from chat to autofill workflow
Add an optional 'context' parameter to the create_file and create_version
agent tools so the chat agent can pass generation/source context (e.g.
'Generated using gemini') to the AI metadata autofill workflow.

- Add Asset.autofillContext column, persisted in the same transaction as
  asset creation when context is provided
- Add new list_autofill_fields agent tool exposing autofillable metadata
  fields (name, type, description, options) per project
- Autofill workflow reads the stored context and includes it in the
  autofill AI prompt
- Add short chat system-prompt guidance to use list_autofill_fields and
  pass <=50 word context when creating files/versions
2026-08-05 10:33:02 +08:00
Yiling-J 30021b07d0 Merge pull request #263 from shumaiOne/feat/agent-create-file-from-content
feat(agent): allow create_file tool to create files directly from content
2026-08-04 21:50:19 +08:00
yiling 07ad0d2f65 feat(agent): allow create_file tool to create files directly from content
Add an optional 'data' field ({name, content}) to the create_file agent tool
so agents can create files without a local file (e.g. when bash is not
available). The existing 'path' upload mode is preserved; exactly one of
'path' or 'data' must be provided.

Extract mime detection helpers (getFileMimeType, readFileMimeType) into a
new file-mime module, keeping utils/mime.ts free of fs/path imports so it
stays compatible with the Temporal workflow bundle (agent-autofill imports
getProxyType from it). Refactor create_version to reuse the extracted
helpers.

Content uploads reuse s3Service.putObject; mime type is derived from the
filename extension with a text/plain fallback, and the name is sanitized
for the S3 key.
2026-08-04 21:16:33 +08:00
Yiling-J 5ef763fbae Merge pull request #262 from shumaiOne/feat/agent-bash-restriction-for-non-owners
feat(agent): restrict bash access for non-owner users
2026-08-04 18:21:22 +08:00
yiling e6fde25446 fix(agent): activate bash tool after skill load and fix chat stream
Two bugs found while testing skill loading as a non-owner:

1. The injected bash tool was never actually usable: AgentHarness.setTools
   only updates the tool registry unless activeToolNames is passed, so bash
   was missing from the active tool set sent to the model on the next turn.
   Pass the full post-update tool list as activeToolNames.

2. The active_tools_change session entry (written by setTools) has no chat
   representation, so mapEntryToMessage fell back to fabricating an empty
   user message that appeared as a stray empty bubble in the chat stream.
   Render active_tools_change as a typed custom message and skip entry
   types that have no chat representation instead of emitting empty text.
2026-08-04 17:01:47 +08:00
yiling dd2f8e68d9 fix(agent): fail closed when user role cannot be resolved
A userId that is not a team member previously resolved to isOwner=true
(role === undefined || role === 'owner'), bypassing bash restrictions.
Treat only flows without a user context (autofill etc.) and explicit
owner memberships as unrestricted; unknown users are now restricted.
2026-08-04 16:26:16 +08:00
yiling c938e84ccc feat(agent): restrict bash access for non-owner users
Editor/reviewer users can no longer ask the agent to run arbitrary bash
commands. Bash execution for them is gated behind approved team skills:

- Add required source param (enum user/skill) to the bash tool; commands
  with source=user are blocked when the user is not a team owner.
- Append a Restricted User Context instruction to the system prompt for
  non-owner users: never run user-requested bash, only skill-required
  commands with source=skill.
- Delay bash tool injection for editor/reviewer: it is only added after
  a skill is successfully loaded via read_skill (or restored when a
  skill was loaded earlier in the session). Team owners are unaffected.
2026-08-04 16:08:04 +08:00
Yiling-J 9745985f57 Merge pull request #261 from shumaiOne/feat/e2e-search-file-list
test(e2e): add search in file list and save-search-as-collection cases
2026-08-04 15:11:37 +08:00
yiling b645a29608 test(e2e): add search in file list and save-search-as-collection cases 2026-08-04 14:52:24 +08:00
Yiling-J deeb02351f Merge pull request #260 from shumaiOne/feat/e2e-file-domain-comments
feat(e2e): add file domain comment and draw tests
2026-08-04 11:25:01 +08:00
yiling c53919b891 ci: add system dependencies installation to app E2E CI job 2026-08-04 11:17:16 +08:00
yiling edf1f6a327 feat(e2e): add file domain comment and draw tests 2026-08-04 10:59:31 +08:00
Yiling-J 1afdbb671b Merge pull request #259 from shumaiOne/feat/project-e2e-tests
test(e2e): add project-level invite and file-move e2e tests
2026-08-03 18:33:48 +08:00
yiling 134d19d907 test(e2e): add project-level invite and file-move e2e tests
Add four project-level webapp e2e tests:
- invite a member to a project; the invitee only sees the invited project
- drag a file into a folder and a folder into another folder
- drag a file onto a file to create a version stack
- drag a file onto a version stack to add a new version

Supporting changes:
- expose rootFolderId on the project fixture
- add seedFolder/seedFile helpers and a cross-browser dragCard helper
  (WebKit requires pointer moves in awaited batches for dnd-kit activation)
- add project-members-trigger testid to the file-browser toolbar
- document the new test cases in the e2e README
2026-08-03 18:04:19 +08:00
yiling 043cde9fcc update agentsmd 2026-08-03 17:09:46 +08:00
Yiling-J 472ffddc99 Merge pull request #258 from shumaiOne/feat/web-e2e-file-share-collection
test(e2e): add file, share, and collection web app e2e tests
2026-08-03 17:07:08 +08:00
yiling 78eb840bf5 test(e2e): upload a 5px png instead of txt to avoid slow transcode 2026-08-03 16:45:38 +08:00
yiling 077536de98 test(e2e): move invite-member spec to the team domain 2026-08-03 16:39:51 +08:00
yiling 3789366d35 test(e2e): add file, share, and collection web app e2e tests
Add six domain-level web app e2e tests covering team member removal,
file upload/delete/restore, share link creation and password protection,
and collection creation. Introduce a parametrized 'file' fixture with
configurable media types (text/binary/image/video/pdf) for future
type-scoped tests, plus helpers for share APIs and team member seeding.

Also document all web app e2e test cases in apps/web/e2e/README.md and
require this documentation in AGENTS.md.
2026-08-03 16:34:37 +08:00
Yiling-J 5647231d7f Merge pull request #257 from shumaiOne/feat/e2e-domain-tests
test(e2e): add domain-based auth and project web app e2e tests
2026-08-03 15:42:32 +08:00
yiling b2a11c5ce9 docs: add Web App E2E Tests section to developer guide 2026-08-03 15:32:38 +08:00
yiling 4532deb753 test(e2e): add domain-based auth and project web app e2e tests 2026-08-03 15:24:21 +08:00
Yiling-J 6efa634f54 Merge pull request #256 from shumaiOne/fix/mention-popup-avatar-and-scroll
fix(webui): mention popup avatars, keyboard auto-scroll, and non-sticky section headers
2026-08-03 14:56:20 +08:00
yiling d696c39622 fix(webui): stop mention popup section headers from sticking and overlapping
Both Agents and Members header buttons had 'sticky top-0', so while
scrolling the 256px mention list the Agents header stayed pinned and the
Members header snapped to the same top position, covering it exactly.
Remove 'sticky top-0' so headers scroll away naturally with their
sections.
2026-08-03 14:47:43 +08:00
yiling 83d22d47a2 fix(webui): show member avatars and auto-scroll in mention popup
- Render real avatar images (with initials fallback) for users in the
  @-mention popup instead of a colored letter circle; bots keep the
  colored fallback since BotInfo has no image field.
- Auto-scroll the highlighted mention row into view when navigating
  the list with ArrowUp/ArrowDown keys.
2026-08-03 14:38:40 +08:00
Yiling-J 4436c3304d Merge pull request #255 from shumaiOne/refactor/use-pi-builtin-providers
refactor(core): replace generated provider files with pi-ai dynamic methods
2026-08-03 11:43:38 +08:00
yiling 2fee708863 feat(agent): implement DatabaseSessionStorage getSessionName and getSessionStats methods 2026-08-03 10:40:33 +08:00
yiling dbe3420b6c feat(agent): update pi packages to 0.82.1 and implement new SessionStorage interface methods 2026-08-03 10:25:10 +08:00
yiling 16d136b45a refactor(core): replace generated provider files with pi-ai dynamic methods 2026-08-03 10:00:21 +08:00
Yiling-J 2656a42c86 Merge pull request #254 from shumaiOne/feat/agent-preference-localstorage
feat(webui): persist agent preference in localStorage
2026-08-02 15:31:00 +08:00
yiling 15910a0bf4 feat(webui): persist agent preference in localStorage 2026-08-02 15:06:51 +08:00
Yiling-J 5458189c1f Merge pull request #253 from shumaiOne/refactor/replace-deprecated-get-model
refactor(agent): load models directly from database without pi fallback
2026-08-02 14:36:54 +08:00
yiling d3aef5f0c1 fix(agent): add required api field to test mock provider config 2026-08-02 14:30:28 +08:00
yiling 5946a679ea refactor(agent): load models directly from database without pi fallback 2026-08-02 14:26:03 +08:00
yiling a54c04e15a update providers 2026-08-01 21:38:42 +08:00
Yiling-J 0bccd13399 Merge pull request #252 from shumaiOne/test/add-missing-core-service-tests
test(core): add missing tests for methods introduced in 97069042
2026-08-01 20:58:15 +08:00
yiling 3b86d9b6d8 test(core): add missing tests for methods introduced in 97069042
Add comprehensive test coverage for 5 core service methods that were
added in the layered architecture refactor but lacked tests:

- AgentService.getAgent: found/not-found cases
- ProjectService.getUserProjects: team scope, project scope,
  multi-team aggregation, limit, and empty result cases
- SkillService.getSkill: full field mapping and not-found cases
- TeamService.hasWritableRoleInAnyTeam: owner, editor, reviewer,
  and no-membership cases
- UserService (new file): getUserById and createGuestUser
2026-08-01 20:44:34 +08:00
Yiling-J 1600949e4a Merge pull request #251 from shumaiOne/feat/audit-log-support
feat(audit): add audit log support for APIs and WebUI dashboard
2026-08-01 19:19:20 +08:00
yiling 2f5b968935 fix(api): fix eslint any type assertion in file.test.ts 2026-08-01 16:35:57 +08:00
yiling 97069042b2 refactor(api): enforce layered architecture by moving db queries to core services 2026-08-01 16:25:01 +08:00
yiling fb66166b49 feat(core): wrap audit log creation in try catch to prevent blocking APIs 2026-08-01 15:50:35 +08:00
yiling b0d8ecb589 refactor(dtos): define AuditAction enum in dtos package to decouple from db 2026-08-01 15:28:23 +08:00
yiling 2d61fae699 refactor(db): consolidate audit log migration into single add_audit_log migration 2026-08-01 15:19:53 +08:00
yiling 5ef7716c9c feat(audit): change audit log action to string at db level and split file/folder actions 2026-08-01 14:49:08 +08:00
yiling 6d80f06c22 refactor(core): update getAssetContext to throw error on missing asset 2026-08-01 11:21:56 +08:00
yiling 0324b95c7e feat(api): add missing audit log calls to API endpoints 2026-08-01 11:03:50 +08:00
yiling 7dfb2c7f2f refactor(dtos): use @shumai/db/enums across DTO definitions 2026-08-01 10:47:41 +08:00
yiling 11fc76e56b refactor(dtos): import AuditAction from @shumai/db/enums subpath 2026-08-01 10:45:10 +08:00
yiling 52f85fcd15 fix(dtos): decouple AuditAction from @shumai/db to prevent leaking DB dependencies to WebUI 2026-08-01 10:41:57 +08:00
yiling 118107ebc9 feat(audit): add audit log support for APIs and WebUI dashboard 2026-08-01 10:39:31 +08:00
Yiling-J 7a83f7d406 Merge pull request #250 from shumaiOne/feat/agent-harness-retry
feat(agent): enable LLM API call retries in AgentHarness
2026-08-01 09:57:22 +08:00
yiling c2d25bd2f1 feat(agent): enable LLM API call retries in AgentHarness 2026-08-01 09:49:43 +08:00
yiling 8e223da8e3 Release v0.3.2 2026-07-30 20:54:48 +08:00
Yiling-J 92147c858f Change demo video link in README_CN.md
Updated demo video link in README_CN.md.
2026-07-30 20:36:36 +08:00
Yiling-J e602e96a28 Change demo video link in README
Updated demo video link in README.
2026-07-30 20:35:57 +08:00
Yiling-J cb1054bc2c Merge pull request #249 from shumaiOne/fix/persist-chatbot-input-text
fix(webui): persist chatbot sidebar input text across route navigation
2026-07-30 17:15:54 +08:00
yiling 87ccbe5330 feat(agent): instruct agent to check if folder exists with list_assets before calling create_folder 2026-07-30 17:08:29 +08:00
yiling 04f0a39300 fix(webui): persist chatbot sidebar input text across route navigation 2026-07-30 17:01:03 +08:00
Yiling-J fd1ff8d70e Merge pull request #248 from shumaiOne/feat/sandboxed-bash-truncation
feat(agent): add output truncation and streaming limits to sandboxed bash tool
2026-07-30 16:44:08 +08:00
yiling 79ea3c3ffd fix(agent): include os.tmpdir() in sandbox allowWrite filesystem configuration 2026-07-30 16:35:36 +08:00
yiling 18780a9117 feat(agent): add output truncation and streaming limits to sandboxed bash tool 2026-07-30 16:21:01 +08:00
Yiling-J 846732d7d4 Merge pull request #247 from shumaiOne/fix/download-asset-original-doc
fix(agent): download original document asset instead of pdf proxy
2026-07-30 15:34:11 +08:00
yiling 1bf22231ec fix(agent): download original document asset instead of pdf proxy 2026-07-30 15:00:53 +08:00
yiling 361e4f32be Release v0.3.1 2026-07-30 11:12:32 +08:00
Yiling-J 5bb546bd8c Merge pull request #246 from shumaiOne/fix/s3-service-property-syntax-and-stream-support
fix(s3): enforce property syntax in S3Service interface and fix ReadableStream handling in S3StorageService
2026-07-30 09:37:39 +08:00
yiling e802469a70 refactor(s3): remove unnecessary type cast on payload in S3StorageService.putObject 2026-07-30 08:36:57 +08:00
yiling 31894bfb59 fix(s3): enforce property syntax in S3Service interface and wrap ReadableStream in Response for S3StorageService 2026-07-30 08:29:18 +08:00
Yiling-J 8a45364160 Merge pull request #245 from shumaiOne/fix/file-size-formatting
fix(webui): update file size formatting to SI decimal standard
2026-07-29 22:57:31 +08:00
yiling a64ed2aa13 fix(webui): update file size formatting to SI decimal standard 2026-07-29 22:43:30 +08:00
Yiling-J c61a23c0c1 Merge pull request #244 from shumaiOne/feat/asset-size-bigint
feat(db): update Asset.sizeByte and AiUsage token fields to BigInt
2026-07-29 22:37:58 +08:00
yiling 668871b730 fix(workflow): map sizeByte BigInt to Number in getAssetActivity for Temporal serialization 2026-07-29 22:31:25 +08:00
yiling cd8a9e58fd test(transcode): assert body is expect.any(ReadableStream) in S3 upload tests 2026-07-29 21:42:54 +08:00
yiling 69c57b16ab test(transcode): update statSync mock for streaming proxy upload assertions 2026-07-29 21:40:25 +08:00
yiling 8837b03b3c refactor(s3): remove unnecessary any cast in LocalStorageProvider putObject 2026-07-29 21:32:53 +08:00
yiling 36ae27fdd5 refactor(s3): add await to writer.write for stream chunk writes 2026-07-29 21:31:05 +08:00
yiling 9a4f8d67c3 feat(transcode): stream uploads and transcode output to prevent memory crashes on large files 2026-07-29 21:22:49 +08:00
yiling 7949c1572a feat(web): update default MAX_REQUEST_BODY_SIZE to 20GB 2026-07-29 20:28:22 +08:00
yiling f161437797 feat(db): update Asset.sizeByte and AiUsage token fields to BigInt 2026-07-29 20:14:23 +08:00
Yiling-J 5b19cfe98e Merge pull request #242 from shumaiOne/feat/add-download-asset-tool
feat(agent): add download_asset tool and prompt instructions
2026-07-29 17:22:05 +08:00
yiling 9ba61b3d3e refactor(agent): simplify download_asset prompt instruction in prompt builder 2026-07-29 17:15:12 +08:00
yiling db04df88f1 feat(agent): add download_asset tool and prompt instructions 2026-07-29 16:56:06 +08:00
Yiling-J 4a4d9cdfb7 Merge pull request #241 from shumaiOne/fix/session-naming-async-and-tools
fix(agent): disable tools for session naming and make naming non-blocking
2026-07-29 16:38:21 +08:00
yiling f1c0f4e50d fix(agent): disable tools for session naming and make naming non-blocking 2026-07-29 16:31:24 +08:00
Yiling-J b49adf8ff1 Merge pull request #240 from shumaiOne/feat/agent-session-on-delete-set-null
feat(db): preserve agent sessions on asset deletion by setting onDelete to SetNull
2026-07-29 15:51:02 +08:00
yiling cdc344ab7a feat(db): preserve agent sessions on asset deletion by setting onDelete to SetNull 2026-07-29 15:42:45 +08:00
Yiling-J f3d42cd0ce Merge pull request #239 from shumaiOne/fix/agent-comment-thread-session
fix(agent): scope agent comment sessions to thread sessions anchored at root comments
2026-07-29 15:33:39 +08:00
yiling bb789a9557 feat(agent): inject reply count alongside Thread ID tag in getPathToRoot 2026-07-29 15:24:55 +08:00
yiling d267c7de98 fix(agent): prevent passing asset IDs to read_thread and improve tool error messages 2026-07-29 15:18:30 +08:00
yiling 1c7a87488b refactor(agent): optimize ULID id sorting and exclude __CHAT__ placeholder comments 2026-07-29 14:59:48 +08:00
yiling a756f7dc2a feat(webui): display session entry ID in Agent Session Logs dialog 2026-07-29 12:05:46 +08:00
yiling 41622f45b4 fix(agent): use upsert in DatabaseSessionStorage appendEntry to handle existing entry IDs 2026-07-29 11:56:11 +08:00
yiling 952323deca fix(agent): include top-level comment entries in Main Session DAG timeline 2026-07-29 11:52:18 +08:00
yiling acb64f44bb fix(agent): prevent userComment entry duplication by passing userCommentId as active prompt entry ID 2026-07-29 11:33:26 +08:00
yiling 343750e178 fix(agent): implement shared DAG tree entries across comment sessions without entry duplication 2026-07-29 11:21:55 +08:00
yiling b75e0c7fdc fix(agent): scope agent comment sessions to thread sessions anchored at root comments 2026-07-29 11:07:47 +08:00
Yiling-J d8c3f46a8d Merge pull request #237 from shumaiOne/feat/agent-sessions-dashboard
feat(dashboard): add agent sessions view for team owners
2026-07-29 10:22:28 +08:00
yiling 48c71efc6c style(dashboard): remove session count from Sessions card title 2026-07-29 10:15:10 +08:00
yiling 35f6206e63 fix(dashboard): resolve creator avatar URLs using getAvatarUrl 2026-07-29 10:13:51 +08:00
yiling 03f8ad90d2 feat(dashboard): add agent sessions view for team owners 2026-07-29 10:10:07 +08:00
Yiling-J 8308bd5bb7 Merge pull request #235 from shumaiOne/fix/enum-autofill-schema
fix(agent): include select option labels and field name in autofill schema
2026-07-28 21:53:01 +08:00
yiling 006fb1726b remove debug log 2026-07-28 21:46:14 +08:00
yiling 19df011dc2 fix(agent): format autofill schema property descriptions with field name and available options list 2026-07-28 21:44:56 +08:00
yiling d6a74b8294 fix(agent): remove title property options from autofill schema for maximum provider compatibility 2026-07-28 21:42:06 +08:00
yiling 37331eae64 fix(agent): include select option labels and field name in autofill schema 2026-07-28 21:32:47 +08:00
Yiling-J 825044f16d Merge pull request #234 from shumaiOne/feat/autofill-post-transcode
feat(transcode): trigger ai metadata autofill post transcode
2026-07-28 20:26:49 +08:00
yiling e51d86e8f0 feat(transcode): trigger ai metadata autofill post transcode 2026-07-28 20:19:10 +08:00
yiling d0d29b34ed Release v0.3.0 2026-07-28 18:56:55 +08:00
Yiling-J 219961755c Merge pull request #233 from shumaiOne/feat/sandbox-weaker-nested-env
feat(agent): support ENABLE_WEAKER_NESTED_SANDBOX environment variable
2026-07-28 18:33:20 +08:00
yiling bca2d26e1d feat(agent): support ENABLE_WEAKER_NESTED_SANDBOX environment variable 2026-07-28 18:28:16 +08:00
yiling 4bd166d7b9 try fixing docker compose sandbox 2026-07-28 16:58:27 +08:00
yiling 51208d3ff0 chore(deps): update @anthropic-ai/sandbox-runtime to 0.0.66 2026-07-28 16:13:40 +08:00
yiling ae5c58d48c try fixing docker compose sandbox 2026-07-28 15:47:03 +08:00
Yiling-J eb73ba7d6a Merge pull request #232 from shumaiOne/fix/analyze-image-s3-mime-type
fix(agent): resolve S3 MIME type detection and prompt parameter in image analysis
2026-07-28 14:40:10 +08:00
yiling 3727879c19 fix(agent): resolve S3 MIME type detection and prompt parameter in image analysis 2026-07-28 14:28:41 +08:00
Yiling-J f46fa31262 Merge pull request #231 from shumaiOne/feat/ci-docker-compose-healthcheck
ci(workflow): add docker compose deployment verification job
2026-07-28 14:12:40 +08:00
yiling 08552c229d ci(workflow): add docker compose deployment verification job 2026-07-28 14:03:48 +08:00
Yiling-J 9dfda1d446 Merge pull request #230 from shumaiOne/fix/sharp-docker-external
fix sharp version mismatch bug
2026-07-28 13:59:43 +08:00
yiling e214036308 fix sharp version mismatch bug 2026-07-28 13:58:52 +08:00
Yiling-J 9da6818adc Merge pull request #229 from shumaiOne/feat/session-storage-refactor
feat(agent): refactor database session storage to normalized DAG entries and lazy thread sync
2026-07-28 13:18:16 +08:00
yiling ff113906d7 refactor(db): strictly type PiSessionEntryData in prisma-json-types and clean up casts 2026-07-28 12:55:38 +08:00
yiling 56421cd562 feat(agent): implement dynamic in-memory thread tagging for session context entries 2026-07-28 11:51:25 +08:00
yiling 4e2694e2d9 feat(agent): refactor database session storage to normalized DAG entries and lazy thread sync 2026-07-28 11:21:31 +08:00
yiling b876af464e feat(file-browser): rename menu item to Copy name and download link 2026-07-27 22:17:07 +08:00
Yiling-J 216538fcfa Merge pull request #227 from shumaiOne/refactor/remove-implicit-agent-mention
refactor(agent): remove implicit agent mention trigger in comment threads
2026-07-27 14:57:29 +08:00
yiling bb71e6bb2a refactor(agent): remove implicit agent mention trigger in comment threads 2026-07-27 14:49:41 +08:00
Yiling-J 9bfa174348 Merge pull request #226 from shumaiOne/feat/inject-user-name-role-chat
feat(agent): inject user name and role into chat context
2026-07-27 14:38:04 +08:00
yiling cd3c7f3641 feat(agent): inject user name and role into chat context 2026-07-27 11:24:48 +08:00
Yiling-J b8345f7c46 Merge pull request #225 from shumaiOne/feat/copy-name-and-path
feat(file-browser): add copy name and path option to context menu
2026-07-27 10:35:51 +08:00
yiling d364e13eb7 fix(file-browser): reuse download-link API url for copy name and path 2026-07-27 10:26:42 +08:00
yiling f429873362 feat(file-browser): add copy name and path option to context menu 2026-07-27 10:23:22 +08:00
Yiling-J d81fc09b35 Change demo video link in README_CN.md
Updated demo video link in README_CN.md.
2026-07-27 09:45:23 +08:00
Yiling-J 6dec8e9786 Update demo video link in README 2026-07-27 09:44:57 +08:00
Yiling-J e1ec56147e Change demo video link in README_CN.md
Updated demo video link in README_CN.md.
2026-07-26 20:51:25 +08:00
Yiling-J 972b1c7458 Update demo video link in README 2026-07-26 20:50:37 +08:00
Yiling-J 07396725aa Revise features and introduce AI Agent functionalities
Updated features section and added AI capabilities for Shumai.
2026-07-26 20:46:43 +08:00
Yiling-J 869bb873cf Update demo video link and media processing details
Updated demo video link and added media processing notes.
2026-07-26 20:35:00 +08:00
Yiling-J fd7b4ca331 Merge pull request #224 from shumaiOne/fix/database-session-storage-p1-bugs
fix(agent): ensure atomic appendEntry and persist leaf entries in DatabaseSessionStorage
2026-07-26 11:25:09 +08:00
yiling c4bba31f20 fix(agent): ensure atomic appendEntry and persist leaf entries in DatabaseSessionStorage 2026-07-26 11:17:59 +08:00
yiling 72654e84b2 Release v0.2.3 2026-07-25 11:49:11 +08:00
Yiling-J cec3821d00 Merge pull request #223 from shumaiOne/test/e2e-video-screenshot-annotation
fix(transcode): handle timestamp rounding tolerance for screenshot annotations
2026-07-25 11:30:18 +08:00
yiling dc3dbcb73e fix(transcode): remove debug logs, keep clean epsilon bugfix 2026-07-25 11:21:45 +08:00
yiling 6226090fd1 fix(e2e): add sharp dependency to packages/e2e 2026-07-25 11:17:32 +08:00
yiling d052c56d39 fix(transcode): handle timestamp rounding tolerance for screenshot annotations 2026-07-25 10:46:20 +08:00
Yiling-J bd13fa7774 Merge pull request #222 from shumaiOne/refactor/split-transcode-workflow-e2e-tests
refactor(e2e): split transcode workflow E2E tests into per-workflow test files
2026-07-25 09:57:36 +08:00
yiling 5e462cc7b1 refactor(e2e): split transcode workflow E2E tests into per-workflow test files 2026-07-25 09:47:20 +08:00
Yiling-J 73c11af9a3 Merge pull request #221 from shumaiOne/fix/file-list-selection-and-dnd-space
fix(webui): fix space key drag overlay and shift range selection for version stacks
2026-07-24 21:13:47 +08:00
yiling adb73b56a2 fix(webui): prevent white focus outline on folder and file cards during selection 2026-07-24 20:57:28 +08:00
yiling e5dcf02b26 fix(webui): fix space key drag overlay and shift range selection for version stacks 2026-07-24 20:47:45 +08:00
Yiling-J 684f88a406 Merge pull request #220 from shumaiOne/fix/refresh-asset-on-agent-tool
fix(webui): refresh file list and detail when agent executes asset creation tools
2026-07-24 20:26:05 +08:00
yiling 8ec970e2bf fix(webui): refresh file list and detail when agent executes asset creation tools 2026-07-24 20:16:58 +08:00
Yiling-J 3eb7894df9 Merge pull request #219 from shumaiOne/fix/default-file-view-right-sidebar-visible
fix(webui): show right sidebar by default on file detail page
2026-07-24 16:18:48 +08:00
yiling 464167ec83 fix(webui): show right sidebar by default on file detail page 2026-07-24 16:16:50 +08:00
yiling dc8c898dae Release v0.2.2 2026-07-23 20:35:22 +08:00
Yiling-J ecc382af61 Merge pull request #218 from shumaiOne/fix/upload-task-completion-status
fix(webui): invalidate upload tasks query when upload task starts and completes
2026-07-23 20:25:44 +08:00
yiling 78dec7626b fix(webui): invalidate upload tasks query when upload task starts and completes 2026-07-23 20:18:37 +08:00
Yiling-J f87033bd3d Merge pull request #217 from shumaiOne/feat/psd-imagemagick-support
feat(transcode): add PSD support via ImageMagick and enforce sRGB conversion
2026-07-23 17:02:11 +08:00
yiling d1b0f3b64f docs: update Windows system requirements in README to include ImageMagick 2026-07-23 16:48:34 +08:00
yiling 8cdbc403db test(e2e): add PSD transcode workflow E2E test 2026-07-23 16:44:56 +08:00
yiling 90adc496dd fix(transcode): update APT package name from imagemagick-7.q16 to imagemagick 2026-07-23 16:34:01 +08:00
yiling 8d1c51abca feat(transcode): add PSD support via ImageMagick and enforce sRGB conversion 2026-07-23 16:19:25 +08:00
Yiling-J 21de21902e Merge pull request #215 from shumaiOne/feat/ai-token-usage-tracking
feat(ai-usage): add team and member token usage tracking and APIs
2026-07-23 15:26:32 +08:00
Yiling-J 330a0b99a9 Merge pull request #216 from shumaiOne/feat/webui-ai-token-usage
feat(webui): integrate AI usage API into dashboard page
2026-07-23 15:10:58 +08:00
yiling df013aa4bb feat(webui): add AI usage dashboard for team and member token tracking 2026-07-23 15:03:09 +08:00
yiling 2c04c97a02 refactor(ai-usage): use Prisma.PrismaClientKnownRequestError for P2002 handling 2026-07-23 11:35:18 +08:00
yiling f6c0a41151 fix(ai-usage): resolve code review feedback for concurrency upsert and timeframe window 2026-07-23 11:29:11 +08:00
yiling f93c8ea524 refactor(agent): invoke harness.subscribe directly without typeof check 2026-07-23 11:11:48 +08:00
yiling 783daa6d3f fix(ai-usage): align since date with top-of-hour bucket boundaries 2026-07-23 11:08:35 +08:00
yiling 1c44e5aff7 feat(ai-usage): add team and member token usage tracking and APIs 2026-07-23 11:02:54 +08:00
Yiling-J 2552d68b98 Merge pull request #214 from shumaiOne/fix/search-result-row-overflow
fix(webui): prevent horizontal overflow in search dialog result rows
2026-07-22 21:18:06 +08:00
yiling 1f714af366 fix(webui): prevent horizontal overflow in search dialog result rows 2026-07-22 21:12:45 +08:00
Yiling-J f0ca7c180b Merge pull request #213 from shumaiOne/fix/sql-query-builder-bugs
fix(search): fix buildSqlCondition date range, numeric metadata, and string parsing bugs
2026-07-22 20:43:26 +08:00
yiling 8aadaa70bf fix(search): fix buildSqlCondition date range, numeric metadata, and string parsing bugs 2026-07-22 20:33:33 +08:00
yiling 6ab650bc80 Release v0.2.1 2026-07-22 20:01:30 +08:00
Yiling-J 1886cbe420 Merge pull request #212 from shumaiOne/fix/provider-update-preserve-model-ids
fix(provider): preserve model ids on provider update
2026-07-22 16:35:08 +08:00
yiling 43dd53a30d fix(provider): preserve model ids on provider update 2026-07-22 16:27:58 +08:00
Yiling-J b1e77db6d0 Merge pull request #211 from shumaiOne/fix/pi-model-fallback
fix(agent): handle non-builtin models in getModelFromDb and upgrade pi-ai
2026-07-22 16:16:26 +08:00
yiling e9959bcc68 fix(agent): handle non-builtin models in getModelFromDb and upgrade pi-ai 2026-07-22 16:09:36 +08:00
Yiling-J fbf963fe43 Merge pull request #210 from shumaiOne/fix/generate-providers-split
refactor(core): split generated providers into per-provider files
2026-07-22 15:09:07 +08:00
yiling c364e0e695 fix(core): guard top-level sync execution and add remote fallback for model data loading 2026-07-22 12:19:37 +08:00
yiling a4b6b0b775 refactor(core): split generated providers into per-provider files 2026-07-22 12:04:07 +08:00
Yiling-J acc255fff4 Merge pull request #209 from shumaiOne/feat/skill-permission
feat(skill): add team owner skill permission control
2026-07-22 11:13:31 +08:00
yiling bc63a95bf5 fix(agent): update agent tools to throw errors directly on failure 2026-07-22 11:05:19 +08:00
yiling bbe1e7128d fix(agent): throw error on read_skill failure instead of returning error content 2026-07-22 10:43:14 +08:00
yiling 9158598c5b feat(skill): add team owner skill permission control 2026-07-22 10:27:32 +08:00
yiling b6afcc135e Release v0.2.0 2026-07-21 21:30:00 +08:00
Yiling-J fb28b7d020 Merge pull request #208 from shumaiOne/feat/agent-media-tools-refactor
feat(agent): refactor media tools to static injection with mandatory assetId and authz
2026-07-21 16:33:12 +08:00
yiling 28c3df3429 fix(agent): require mandatory userId for media tools and optimize authz 2026-07-21 16:22:14 +08:00
yiling 93e957fa4f feat(agent): refactor media tools to static injection with mandatory assetId and authz 2026-07-21 16:09:39 +08:00
Yiling-J 1ac0d1452e Merge pull request #207 from shumaiOne/fix/version-stack-agent-chat
fix(agent): pass latest version asset from version stack to prompt builder
2026-07-21 15:16:55 +08:00
yiling 5855134236 fix(agent): pass latest version asset from version stack to prompt builder 2026-07-21 15:04:38 +08:00
Yiling-J 581a12bdc9 Merge pull request #206 from shumaiOne/fix/latest-children-trashed-files
fix(asset): exclude soft-deleted children from latestChildren preview
2026-07-21 11:33:37 +08:00
yiling 851e5d975c fix(asset): exclude soft-deleted children from latestChildren preview 2026-07-21 11:19:20 +08:00
Yiling-J 6e69fc451b Merge pull request #205 from shumaiOne/fix/include-skill-id-in-prompt
fix(agent): include skill id in formatSkillsForPrompt
2026-07-21 10:46:39 +08:00
yiling b91033495c fix(agent): include skill id in formatSkillsForPrompt 2026-07-21 10:42:01 +08:00
Yiling-J a2895cd5d1 Merge pull request #204 from shumaiOne/feat/chat-context-asset-change
feat(chat): track context asset changes and update agent context
2026-07-21 10:13:09 +08:00
yiling e3352232fe feat(chat): track context asset changes and update agent context 2026-07-21 10:01:22 +08:00
Yiling-J 6d34b13266 Merge pull request #203 from shumaiOne/feat/markdown-proxy
feat(transcode): add markdown file to pdf proxy support
2026-07-20 18:37:54 +08:00
yiling 208eb6898a feat(transcode): add markdown file to pdf proxy support 2026-07-20 18:35:16 +08:00
Yiling-J b1d9c1b31b Merge pull request #202 from shumaiOne/add-fonts-noto-cjk-to-dockerfile
feat(docker): install fonts-noto-cjk in runner stage
2026-07-20 16:36:18 +08:00
yiling c016d1dffe feat(docker): install fonts-noto-cjk in runner stage 2026-07-20 16:35:19 +08:00
Yiling-J 7cd8a5bef7 Merge pull request #201 from shumaiOne/fix/transcode-pdf-font
fix(transcode): mark pdfkit as external and extract for docker runtime
2026-07-20 16:16:05 +08:00
yiling 3274d19574 fix(transcode): mark pdfkit as external and extract for docker runtime 2026-07-20 16:12:59 +08:00
Yiling-J 047174c13d Add Discord link to README 2026-07-20 15:05:43 +08:00
Yiling-J d9d7b52758 Merge pull request #200 from shumaiOne/feat/use-proxy-type
feat(asset): replace mediaType/mimeType logic with proxyType
2026-07-20 14:59:39 +08:00
yiling 52edcd1a79 fix(transcode): fix unused import and set proxyType in transcode workflow tests 2026-07-20 14:50:43 +08:00
yiling 3afe0fc3c3 feat(api): remove mediaType and mimeType from DTO responses and DB MediaInfo interface 2026-07-20 14:37:17 +08:00
yiling 5d4020dc2d fix(mime): restrict pdf proxyType strictly to pdf, csv, and txt files 2026-07-20 11:50:19 +08:00
yiling 4ad0df5876 fix(agent): block non-pdf assets in read_pdf_pages and remove mediaType fallback in AgentChatPromptBuilder 2026-07-20 11:01:22 +08:00
yiling fea153e94f fix(asset): resolve DTO schema and test typecheck errors for proxyType 2026-07-20 10:46:20 +08:00
yiling f158d04686 feat(asset): replace mediaType/mimeType logic with proxyType 2026-07-20 10:22:36 +08:00
Yiling-J c45a1d9ee9 Merge pull request #199 from shumaiOne/feat/txt-csv-pdf-proxy
feat(transcode): add PDF proxy support for TXT and CSV files
2026-07-20 09:41:28 +08:00
yiling 29995a64fd fix(transcode): add fontName to Linux TTC fonts, Windows CJK paths, and Droid fallback 2026-07-20 09:35:49 +08:00
yiling 1970535aa6 fix(transcode): use csv-parse for CSV parsing and pin pdfkit exact version 2026-07-19 22:46:13 +08:00
yiling 7574dd56e4 feat(db): add backfill migration for media.proxyType 2026-07-19 21:21:31 +08:00
yiling 081dbf6d39 feat(transcode): add PDF proxy support for TXT and CSV files 2026-07-19 21:19:43 +08:00
Yiling-J 817889e501 Merge pull request #197 from shumaiOne/feat/split-transcode-workflows
feat(transcode): split monolithic transcodeMedia into focused workflows
2026-07-19 15:01:38 +08:00
yiling aa572bf2d6 docs(transcode): add deprecation notice to legacy transcodeMedia workflow 2026-07-19 14:50:31 +08:00
yiling d9ed30fedb ci: install poppler-utils and ffmpeg system dependencies for workflow E2E tests 2026-07-19 14:43:04 +08:00
yiling 7d7a1b61c0 test(e2e): add E2E test for renderPdfPagesWorkflow 2026-07-19 13:27:07 +08:00
yiling cbe622dfeb feat(transcode): split monolithic transcodeMedia into focused workflows 2026-07-19 12:32:08 +08:00
Yiling-J b72a9435e7 Merge pull request #196 from shumaiOne/feat/agent-read-pdf-pages
feat(agent): add read_pdf_pages tool and PDF page context support
2026-07-19 12:14:20 +08:00
yiling 759e37915b refactor(transcode): add overlayAnnotationsOnBuffer and add pixel verification tests 2026-07-19 12:03:23 +08:00
yiling e2523e1a81 perf(transcode): optimize PDF page rendering pipeline using in-memory sharp buffers 2026-07-19 10:18:50 +08:00
yiling 6064a1449a fix(agent): enforce page range validation and refine pdftoppm error check 2026-07-19 10:17:21 +08:00
yiling f68ba70656 feat(agent): add read_pdf_pages tool and PDF page context support 2026-07-19 09:45:14 +08:00
Yiling-J 68a0fb7319 Merge pull request #195 from shumaiOne/feat/pdf-worker-route
feat(web): register pdf.worker route in production
2026-07-18 19:44:43 +08:00
yiling 661ec06cef fix(webui): ensure pdf.worker path is root-relative 2026-07-18 19:14:56 +08:00
yiling 6000b8e366 feat(web): register pdf.worker route manually in prod mode 2026-07-18 19:10:07 +08:00
Yiling-J db3551de1d Merge pull request #193 from shumaiOne/feat/pdf-support
feat(transcode): add PDF preview, sprite generation, and annotation support
2026-07-18 15:42:15 +08:00
yiling dc20c7f548 test(e2e): add PDF workflow E2E test case using test.pdf fixture 2026-07-18 15:33:05 +08:00
yiling f76e7a8e8d fix(webui): cancel renderTask immediately if active flag is false before or during render 2026-07-18 15:17:38 +08:00
yiling cfdc085ae7 chore(deps): move pdfjs-dist to webui package.json and clean root dependencies 2026-07-18 15:15:45 +08:00
yiling 779706a3e7 test(core): add unit tests for generatePdfSprite and getPdfInfo in TranscodeService 2026-07-18 15:07:28 +08:00
yiling 06dc929a2a fix(webui): destroy loadingTask and cancel renderTask on unmount 2026-07-18 14:05:10 +08:00
yiling 0ad3aca083 fix(webui): add type declaration for *.mjs worker imports 2026-07-18 14:03:31 +08:00
yiling b59f439683 feat(webui): self-host pdf.worker.min.mjs in public directory 2026-07-18 13:08:55 +08:00
yiling d270f3f62c fix(webui): add keyboard navigation shortcuts for PDF viewer 2026-07-18 11:25:59 +08:00
yiling ea201ad19f feat(webui): support custom timestamp formatting for PDF viewer comments (P9) 2026-07-18 11:20:13 +08:00
yiling 2b72f3038a fix(webui): enable hasTimestamp for PDF viewer comments configuration 2026-07-18 10:55:29 +08:00
yiling c1ddbe4be7 fix(webui): sync pdf page with seekTo and onTimeUpdate 2026-07-18 10:49:53 +08:00
yiling 3ada194a8e fix(asset): presign poster thumbnail for PDF and poster-enabled assets 2026-07-18 10:41:28 +08:00
yiling bc1491bed5 feat(transcode): add PDF preview, sprite generation, and annotation support 2026-07-18 10:32:38 +08:00
yiling 3383079787 Release v0.1.10 2026-07-16 16:48:25 +08:00
Yiling-J f888a575b2 Merge pull request #192 from shumaiOne/feat/disable-agent-tools
feat(agent): support disabling specific tools for agents
2026-07-16 16:38:32 +08:00
yiling 0a7d5d1f46 feat(agent): support disabling specific tools for agents 2026-07-16 15:56:56 +08:00
Yiling-J 879922a9fe Merge pull request #191 from shumaiOne/feat/comment-delete-video-shortcuts
feat(comments): support comment deletion and video player shortcuts
2026-07-16 11:16:18 +08:00
yiling 58967d1a63 minor ui improvement 2026-07-16 11:06:26 +08:00
yiling e978878a90 refactor(comments): unconditionally delete S3 attachment objects directly 2026-07-16 10:59:14 +08:00
yiling ecfbfc2bac fix(shortcuts): resolve keyboard accessibility and contenteditable issues 2026-07-16 10:23:47 +08:00
yiling 490c6a3da6 refactor(comments): simplify teamId lookup and clean up comment attachments in S3 and database 2026-07-16 10:17:32 +08:00
yiling 62b1fc1d37 feat(comments): support comment deletion and video player shortcuts 2026-07-16 09:55:05 +08:00
Yiling-J fa6bf73452 Merge pull request #189 from shumaiOne/feat/workflow-e2e-tests
test(e2e): add E2E workflow tests for remaining agent and transcode services
2026-07-15 15:36:41 +08:00
yiling 25c747aa87 test(e2e): add E2E workflow tests for remaining agent and transcode services 2026-07-15 15:19:25 +08:00
Yiling-J ff7712744d Merge pull request #188 from shumaiOne/feat/workflow-e2e-tests
feat(workflow-e2e): add E2E tests for agentAutofillMedia workflow
2026-07-15 14:45:04 +08:00
yiling 6f369625d8 docs(agents): update AGENTS.md with E2E workflow testing requirements 2026-07-15 12:04:45 +08:00
yiling c6acd075e7 refactor(workflow-core): statically import Worker type from @temporalio/worker to ensure activeWorkers type-safety 2026-07-15 11:58:17 +08:00
yiling 7d9f3276f1 test(e2e): verify multiple types in autofill and check that non-autofill field is ignored 2026-07-15 11:54:29 +08:00
yiling d524a81ecd chore(vitest): exclude packages/e2e/** from root unit test suite 2026-07-15 11:40:57 +08:00
yiling 83c427e646 refactor(e2e): mock LLM prompt via AgentHarness prototype spy instead of global activity override 2026-07-15 10:52:01 +08:00
yiling b018fd0fec feat(workflow-e2e): add E2E tests for agentAutofillMedia workflow
- Setup E2E package under packages/e2e
- Use testcontainers to spin up postgres and temporal dev server
- Overwrite activities in global registry to mock AI model output
- Track temporal workers and expose shutdownWorkers() method for clean shutdown
- Integrate test:e2e:workflow into root package.json and GitHub actions CI
2026-07-15 10:14:59 +08:00
yiling 8efc9c1865 Release v0.1.9 2026-07-14 20:21:21 +08:00
Yiling-J 0eeb2f18f3 Merge pull request #187 from shumaiOne/fix/chat-api-db-queries
refactor(api/chat): remove direct Prisma query from API layer
2026-07-14 16:47:44 +08:00
yiling 6643d63e81 refactor(api/chat): remove direct Prisma query from API layer
API layer routes in packages/api/src/chat.ts accessed the database directly via prisma, violating communication layer boundaries.

This refactoring migrates these queries to packages/core/src/chat/chat.ts:
- Added getNewSessionMessages to fetch mapped SSE entries.
- Added getChatWorkflowStatus to check task completions.
- Added abortSession to handle workflow cancellation and task updates in core.
- Updated both core and API tests to match refactored signatures and mock boundaries.
2026-07-14 16:40:55 +08:00
Yiling-J b53b76bc6e Merge pull request #186 from shumaiOne/feat/agent-abort
feat(agent): support aborting agent execution
2026-07-14 16:35:19 +08:00
yiling 636e92af4c fix(agent): unregister temporal cancellation listener on completion 2026-07-14 16:08:43 +08:00
yiling a7dc7bbff2 perf(agent): optimize active task lookup using indexed sessionId column 2026-07-14 15:44:10 +08:00
yiling cd48d2d389 fix(agent): resolve lint, typecheck, and stop button UI issues 2026-07-14 10:35:25 +08:00
yiling 8a942d4f4e feat(agent): support aborting agent execution in local and temporal modes 2026-07-14 10:25:06 +08:00
Yiling-J e772581542 Merge pull request #185 from shumaiOne/feat/chatbot-ui-layout
feat(chat): chatbot UI
2026-07-13 16:55:25 +08:00
yiling 7baf95e48c fix(webui): preserve chatbot sidebar scroll position across navigations 2026-07-13 16:49:04 +08:00
yiling 15cbf12162 fix(webui): render theme-aware markdown code blocks in dark/light mode 2026-07-13 14:52:38 +08:00
yiling d560032013 feat(chat): send SSE keep-alive ping heartbeats during polling 2026-07-13 12:17:00 +08:00
yiling 02f2fde8ac fix(chat): remove explicit any in test mock to fix CI lint 2026-07-13 11:52:44 +08:00
yiling e080167ac5 feat(chat): enforce team-scoped authorization and session creator check
- Update chat API routes and service methods to include and verify teamId context
- Validate that the requesting user is the creator of the chat session during continuation
- Update frontend chatbot store and components to pass teamId parameter
- Update backend API/core and frontend store tests to verify team scoping and creator checks
2026-07-13 11:35:55 +08:00
yiling 61c49b4d7f feat(chat): allow user to choose chatbot in sidebar
- Remove chatbotAgentId from team settings and schema definition
- Make agentId a required parameter in ChatRequest DTO and chatService
- Fetch chatbot agents on chatbot sidebar mount and default to first enabled chat agent
- Render an agent selector dropdown inside the message input area
- Update existing chat sessions to follow the selected agent when continuing a conversation
2026-07-13 10:10:56 +08:00
yiling bad93466ae feat(webui): use filled bot icon when chatbot sidebar is open 2026-07-13 09:37:37 +08:00
yiling 1f8b0bac21 update ui 2026-07-13 09:34:51 +08:00
yiling c55380c0fd feat(webui): make toolCall block collapsible and render footer conditionally 2026-07-12 15:40:21 +08:00
yiling 3de57fd176 feat(webui): refactor chatbot message rendering to type-safe nested switch 2026-07-12 15:18:31 +08:00
yiling 0a4622ed8a syle minor fix 2026-07-12 10:29:29 +08:00
yiling bcb17acaf7 chore(serve): set idleTimeout to 120 seconds in Bun.serve 2026-07-11 21:11:18 +08:00
yiling b57a3e0239 chore(chat): support isNewChat payload flag and fix any casts 2026-07-11 21:05:47 +08:00
yiling c5ce4d07e9 feat(chat): add chatbot session name generation 2026-07-11 20:54:09 +08:00
yiling b5d52a4e56 feat(chat): add AgentSessionType enum and filter chatbot history sessions 2026-07-11 20:14:40 +08:00
yiling 94a3ec0b9b feat(chat): support optimistic context display entry locally during message sending 2026-07-11 17:02:58 +08:00
yiling bd897b951a chore: format codebase 2026-07-11 16:58:37 +08:00
yiling 482df3315c feat(chat): append and display context_display_info custom entry for attached assets 2026-07-11 16:58:09 +08:00
yiling cc9b32716d feat(chat): filter out context messages from API list and SSE stream 2026-07-11 15:47:48 +08:00
yiling 35db3fc49e fix(chatbot): preserve historical message order during SSE playback 2026-07-11 15:12:59 +08:00
yiling 6a5f8db0d6 fix(chatbot): preserve optimistic message during history playback of active sessions 2026-07-11 15:08:07 +08:00
yiling b13c47f207 feat(chatbot): highlight entire sidebar area with semi-transparent cover on dragover 2026-07-11 14:56:21 +08:00
yiling 2f68043e17 fix(chatbot): clear attached assets on message send and remove drag-drop toast 2026-07-11 14:41:23 +08:00
yiling 3d266a5606 feat(chatbot): remove agentId from request and resolve it via team settings, toggle chatbot icon with tooltip guard 2026-07-11 11:49:38 +08:00
yiling 87d811dad6 style(chatbot): move send button inside input border area to match comment input design 2026-07-11 10:59:56 +08:00
yiling 4a7da10ca8 fix(chatbot): prevent Enter from sending message during IME composition 2026-07-11 10:55:01 +08:00
yiling d19200e9ef feat(chatbot): implement chatbot sidebar, message view, history mode and sse stream 2026-07-11 10:49:40 +08:00
yiling 77718a3e1a refactor(webui): render chatbot button as standalone Bot icon outside the toggle group 2026-07-11 10:19:41 +08:00
yiling 8d2d915f36 feat(webui): add chatbot layout and drag-drop context store 2026-07-11 10:16:46 +08:00
Yiling-J 6ede64495f Merge pull request #184 from shumaiOne/feat/app-e2e-tests
feat(e2e): set up fullstack app-level e2e test framework and signup test case
2026-07-10 23:06:16 +08:00
yiling 13f220ef0f refactor(e2e): replace S3 bucket name check with explicit SHUMAI_E2E env flag 2026-07-10 20:11:54 +08:00
yiling 4e9fae96b1 fix(ci): split E2E jobs and support skipping app server via E2E_SKIP_APP_SERVER 2026-07-10 19:41:31 +08:00
yiling 8d23d8b1c3 fix(ci): split E2E tests into harness and app jobs 2026-07-10 19:28:14 +08:00
yiling 1e1ddd1a3d fix(e2e): declare types dependencies and adjust CI projects execution using --no-deps 2026-07-10 19:10:30 +08:00
yiling 55457fcd36 fix(webui): snap playhead to last frame upon ended event in useFramePlayer 2026-07-10 16:35:41 +08:00
yiling 9414ebaefd feat(e2e): run harness tests in parallel and app E2E tests sequentially using project dependencies 2026-07-10 16:27:51 +08:00
yiling 515c491d5d fix(e2e): restore Playwright empty object destructuring for fixture parameters 2026-07-10 16:21:09 +08:00
yiling 0aba2ee557 refactor(e2e): migrate database reset logic to standard Playwright custom fixture 2026-07-10 16:18:45 +08:00
yiling cd96015b9d feat(e2e): add browser selection support for app-level E2E tests 2026-07-10 15:35:59 +08:00
yiling 26982ee494 feat(e2e): set up fullstack app-level e2e test framework and signup test case 2026-07-10 15:21:01 +08:00
Yiling-J af5c85a87b Add installation command for ffmpeg using Chocolatey 2026-07-10 09:57:21 +08:00
yiling 5636a1b581 Release v0.1.8 2026-07-10 09:39:40 +08:00
Yiling-J 27af3a315e Merge pull request #183 from shumaiOne/fix/splitting-build-error
fix(webui): enable build splitting and code-split all page routes
2026-07-09 20:14:23 +08:00
yiling d3bbd42208 fix(web): optimize serveMainHtml performance by processing HTML at startup 2026-07-09 15:50:09 +08:00
yiling c3d88bb972 docs: add concise route code-splitting guideline to AGENTS.md 2026-07-09 15:32:15 +08:00
yiling a80e9de6cc feat(webui): code-split remaining team and share sub-routes to optimize vendor chunk size 2026-07-09 15:16:33 +08:00
yiling 6b5c2d8b23 feat(webui): enable route-level manual code-splitting to optimize bundle size 2026-07-09 15:09:39 +08:00
yiling 8d19b578e7 fix(build): resolve code-splitting chunk import issue on backend and frontend 2026-07-09 15:00:23 +08:00
Yiling-J e20e147445 Merge pull request #182 from shumaiOne/update-readme-notes
docs(readme): clarify displayed file size represents original file size
2026-07-09 10:40:58 +08:00
yiling 2116f2b1ab docs(readme): clarify displayed file size represents original file size 2026-07-09 10:40:24 +08:00
Yiling-J 7889b08008 Merge pull request #180 from shumaiOne/feat/chatbot-backend-apis
feat(chatbot): implement type-safe Chat APIs with compaction support
2026-07-08 10:07:00 +08:00
yiling 10279d74bc feat(chatbot): append turn-specific agentsInstruction as a custom message session entry 2026-07-07 21:51:10 +08:00
yiling 985bf0170c fix(api): prevent SSE connection resource leak by checking stream.aborted 2026-07-07 20:59:25 +08:00
yiling f04729b4bf refactor(chatbot): use SessionTreeEntry type directly in ChatService, removing SimpleMessageEntry 2026-07-07 14:16:31 +08:00
yiling 55026af22e refactor(chatbot): import AgentMessage type statically in DTO layer 2026-07-07 12:30:41 +08:00
yiling b8eddcd854 feat(chatbot): return rich AgentMessage structure directly from listMessages API 2026-07-07 12:25:32 +08:00
yiling d326a4cab8 refactor(chatbot): make mapEntryToMessage fully type-safe without any casts 2026-07-07 12:04:08 +08:00
yiling 243a4ab2c5 feat(chatbot): remove manual AgentSessionEntry creation from ChatService 2026-07-07 11:50:31 +08:00
yiling e4c1830e02 feat(chatbot): delegate context prompt building to AgentChatPromptBuilder in workflow 2026-07-07 11:42:40 +08:00
yiling 7b6db5b56c feat(chatbot): require agentId in ChatRequest and validate agent presence 2026-07-07 11:27:29 +08:00
yiling 63590d5329 feat(chatbot): decouple chatbot sessions from AssetComment table 2026-07-07 11:12:15 +08:00
yiling ccf742e158 refactor(chatbot): make user parameter in startOrContinueChat type-safe 2026-07-07 11:04:51 +08:00
yiling e55ee3a3f0 feat(chatbot): add chatbot backend api support 2026-07-07 10:55:22 +08:00
yiling 5e73fcf4aa update readme 2026-07-07 09:32:23 +08:00
yiling ca5f54b385 update readme 2026-07-07 09:27:50 +08:00
yiling 6e460430dd Release v0.1.7 2026-07-06 13:01:47 +08:00
yiling ffc578cb45 fix(comments): prevent reload of main viewer by invalidating only comments queries 2026-07-06 12:51:25 +08:00
Yiling-J 1414632c4a Merge pull request #179 from shumaiOne/feat/comment-completion
feat(comments): allow marking comments as complete or incomplete
2026-07-06 12:50:04 +08:00
yiling a312ecf7ef style(comments): use custom filled circle check icon and make actions row always visible 2026-07-06 12:40:20 +08:00
yiling e1d3dd46db feat(comments): allow marking comments as complete or incomplete 2026-07-06 12:24:40 +08:00
yiling af7d636f31 update cn translate 2026-07-06 11:49:51 +08:00
yiling b98b710222 update doc 2026-07-06 11:22:32 +08:00
Yiling-J 79b19d3983 Revise feature descriptions in README_CN.md
Updated feature descriptions and improved clarity in the README_CN.md file.
2026-07-06 11:15:29 +08:00
yiling 474fe7ced1 fix(webui): center unread badge count 2026-07-06 11:06:09 +08:00
Yiling-J bf82eff068 Merge pull request #178 from shumaiOne/feat/i18n-fixes
feat(i18n): localize members dialog, notifications, uploads, user menus, dates, and players
2026-07-06 10:59:24 +08:00
yiling 01a9c7cde6 refactor(i18n): address code review feedback on string legos, hardcoded locales, and fragile checks 2026-07-06 10:52:55 +08:00
yiling 45f3255796 feat(i18n): localize members dialog, notifications, uploads, user menus, dates, and players 2026-07-06 10:38:41 +08:00
Yiling-J 64ad183bc1 Merge pull request #177 from shumaiOne/docs-s3-storage
docs: improve documentation and examples for S3 compatible storage
2026-07-06 10:20:31 +08:00
yiling af8bc30409 docs: improve documentation and examples for S3 compatible storage 2026-07-06 10:13:12 +08:00
Yiling-J aac8bea4e8 Merge pull request #176 from shumaiOne/fix/upload-mime-type
fix(upload): resolve empty and generic MIME types in confirmFileUpload
2026-07-05 22:10:22 +08:00
yiling a05c0ac0db fix(upload): resolve empty and generic MIME types in confirmFileUpload
Use Bun's built-in file resolver to fall back to extension-based MIME type detection when the mediaType is missing, empty, or generic ('application/octet-stream').
2026-07-05 21:55:26 +08:00
Yiling-J 714158b5b2 Merge pull request #175 from shumaiOne/feat/audio-support
feat(audio): support frame-accurate audio playback, comments, and AI safeguards
2026-07-05 19:33:37 +08:00
yiling 8ad25215dd refactor(agent): prevent creating autofill and embedding tasks for audio assets 2026-07-05 16:31:14 +08:00
yiling 73aa374b2b feat(agent): prevent exposing screenshot and analyze_image tools and executing autofill/embeddings for audio files 2026-07-05 16:26:48 +08:00
yiling cee4142936 style(webui): use dark background for audio preview to keep duration clear 2026-07-05 16:16:04 +08:00
yiling 0f6912c977 feat(webui): render duration overlay for audio files in file browser 2026-07-05 16:13:00 +08:00
yiling 868e7b2a7b fix(webui): remount file viewer when file ID changes to reset state 2026-07-05 16:10:01 +08:00
yiling ccfcdce23c fix(upload): correct .wma MIME type to audio prefix on upload and add tests 2026-07-05 15:57:29 +08:00
yiling 8d336836cc test(webui): add audio comment seek roundtrip E2E test case 2026-07-05 15:37:30 +08:00
yiling f24c8afa3d test(webui): add e2e test to verify playhead advances immediately for audio assets 2026-07-05 15:28:18 +08:00
yiling e511af219e fix(webui): immediately use currentTime fallback in useFramePlayer for audio files 2026-07-05 15:23:52 +08:00
yiling 5cae1adce1 fix(webui): hide zoom/fit controls and comment draw button for audio assets 2026-07-05 15:19:53 +08:00
yiling a2e982f2e6 feat(transcode): add audio file support with AAC stereo mp4 proxy and styled viewer 2026-07-05 15:11:19 +08:00
Yiling-J 9a7abaed1a Merge pull request #174 from shumaiOne/refactor/file-viewer-registry
refactor(webui): modularize file viewer components into registry-driven architecture
2026-07-05 12:40:41 +08:00
yiling e03c44a00e docs(webui): add file viewer registry developer documentation 2026-07-05 12:26:50 +08:00
yiling 1524d41392 fix(webui): resolve react hook order violation in video viewer 2026-07-05 12:04:35 +08:00
yiling 4cc35d3453 refactor(webui): modularize file viewer components into registry-driven architecture 2026-07-05 10:51:42 +08:00
yiling 229070fe19 Release v0.1.6 2026-07-04 21:39:52 +08:00
Yiling-J 3bfbd2c217 Merge pull request #173 from shumaiOne/fix-version-stack-comments
fix(version-stack): resolve correct latest version ID of version stack
2026-07-04 21:07:00 +08:00
yiling 481c1ff8ba fix(version-stack): resolve correct latest version ID of version stack 2026-07-04 20:56:31 +08:00
Yiling-J 5f6847a373 Merge pull request #172 from shumaiOne/fix/video-player-frame-count-mismatch
fix(webui): resolve video player total frames mismatch
2026-07-04 20:47:09 +08:00
yiling 175b5ac171 fix(webui): resolve video player total frames mismatch
Avoid deriving total frames from container duration when the audio tail mismatch is below the dynamic playback stall threshold. This prevents the rendering of phantom trailing frames that the playhead cannot reach during playback.

Also adds comprehensive unit and E2E tests covering both small and large audio tail gaps.
2026-07-04 16:44:09 +08:00
Yiling-J f32f2d43aa Merge pull request #171 from shumaiOne/feat/compare-versions
feat(webui): compare versions view for version stacks
2026-07-04 15:38:37 +08:00
yiling ba88cdad78 fix(webui): sync compare video pane resolution/source on asset change
currentResolution state and currentSrcRef were only initialized on mount,
so if file.id changed without a remount the video.js init effect (keyed on
file.id) would re-create the player with a stale source. Add an effect
that resets them when file.id changes, before the init effect runs, making
the pane robust even without a per-asset key on the parent.
2026-07-04 15:29:07 +08:00
yiling 0bbb846beb fix(webui): support version switching on public share (no login redirect)
Switching a version in the public share breadcrumb navigated to the
authenticated /projects/:id/files/:id route, which triggered the
authenticated /api/projects/:id/team call (via resolveTeamIdFromPath) ->
401 -> redirect to login.

- breadcrumb handleVersionClick now routes to /share/:shareId/files/:id
  with a version search param when public.
- public share route gains a version param; PublicShareManager fetches the
  stack asset (for the version list) and the active version child asset
  (for display/comments/fields), mirroring the authenticated page.
- compare exit sets version to the active side for parity.
2026-07-04 15:22:38 +08:00
yiling c793e0dd78 fix(webui): keep fullscreen controls visible while cursor is over them
Track when the cursor is over the control bar (VideoControlBar now
forwards mouse enter/leave) and skip the idle-hide timer while it is, so
the bar no longer disappears when the cursor rests on it. Also reduce the
fullscreen auto-hide delay from 2s to 1.2s.
2026-07-04 13:15:52 +08:00
yiling 13833e8144 fix(webui): auto-hide fullscreen controls on idle regardless of play state
The fullscreen control bar only auto-hid while playing, and a separate
effect force-showed it whenever paused, so it stayed visible permanently
when paused in fullscreen. Now in fullscreen the bar shows on cursor move
and hides after the cursor is idle (~2s) whether playing or paused;
windowed mode keeps the bar always visible.
2026-07-04 13:04:25 +08:00
yiling d3c1c641b4 fix(webui): show control bar in single-file fullscreen; theme the overlay
The single-file player fullscreened the inner video-area element, which
is not an ancestor of the control bar, so the bar was never visible in
fullscreen. Fullscreen the player root instead so the floating control
bar is included and the existing show-on-move / hide-after-idle logic
works (YouTube-style).

Also make the control-bar colors theme-aware in all cases. The fullscreen
floating overlay now uses bg-card/90 + backdrop-blur + foreground text
instead of a hardcoded dark overlay, so it follows the app light/dark
theme. The former themedChrome prop is renamed to floatOverlayInFullScreen
(default true = single-file floating overlay; compare passes false to keep
its bar in-flow).
2026-07-04 12:48:15 +08:00
yiling aeaff3bc88 feat(webui): compare fullscreen control bar follows app theme
Add a themedChrome prop to VideoControlBar that keeps the normal
theme-aware chrome (bg-card / foreground text) while fullscreen instead
of the dark video overlay. Compare mode passes it so its fullscreen bar
matches the app light/dark theme for both video- and image-active panes
(ImageControlBar is already themed). The single-file player is unchanged
(themedChrome defaults to false -> dark overlay). The fullscreen toggle
icon still reflects the actual fullscreen state.
2026-07-04 12:28:08 +08:00
yiling cf005797be fix(webui): readable zoom/Fit controls in fullscreen light mode
In the fullscreen control bar the whole bar uses text-white (it overlays
the dark video), but the zoom group and Fit button hardcoded bg-muted,
which is light in light mode -> white text on a light background. Use a
translucent bg-white/15 for those controls when fullscreen so they stay
readable; the normal (non-fullscreen) bar keeps bg-muted. Also fixes the
same latent issue in the single-file video player.
2026-07-04 11:36:04 +08:00
yiling 4b3b31c83d style(webui): compare pane topbar is always dark with light text
Force the dark palette on the compare pane topbar (via a scoped `dark`
class + system tokens, no hardcoded hex) so the bar background is dark in
both light and dark app themes. Active pane text uses text-foreground
(white in the dark scope); inactive pane uses text-muted-foreground
(light gray).
2026-07-04 11:25:39 +08:00
yiling a4e25db0f7 style(webui): emphasize active compare pane topbar
The active version's topbar now uses an inverted bar (bg-foreground /
text-background) so it reads as black background with white text in the
light theme, while the inactive pane keeps the card background with muted
text. Filename/version text color now differs between active and inactive
panes.
2026-07-04 11:19:50 +08:00
yiling 78c8a56183 fix(webui): clicking an inactive compare pane only activates it
Previously clicking a non-active video pane both switched the active
version and toggled playback. Now a click on an inactive pane only makes
it active; play/pause is only toggled when clicking the already-active
pane.
2026-07-04 10:56:55 +08:00
yiling e2d4944060 refactor(webui): extract shared Video/Image control bars and reuse in compare
Extract the video player's inline ControlBar into an exported
viewers/video-control-bar.tsx (VideoControlBar + PlayerState +
DisplayTranscode) and the image toolbar from file-viewer into an exported
viewers/image-control-bar.tsx (ImageControlBar). video-player and
file-viewer now consume the shared components with unchanged behavior.

compare-control-bar composes the same two shared bars (video vs image
active) with fan-out handlers, so the compare control bar can no longer
drift from the single-file players (e.g. the time-format dropdown).
2026-07-04 10:49:00 +08:00
yiling 6c3d3ea2b3 feat(webui): add compare versions view for version stacks
Add a Compare Versions mode to the file detail page (authenticated and
public share) that splits the viewer into two 50/50 panes showing two
versions side by side.

- Breadcrumb file menu gains a Compare Versions entry (version stacks
  with >=2 versions); the file segment is hidden in compare mode.
- URL-driven state (compare/cmpLeft/cmpRight/cmpActive) on both file
  routes so the view is refresh/share-safe.
- Per-side topbar with filename, version, version-switch dropdown, an
  active-side highlight, and an X exit button.
- Shared control bar reflects the active pane; for same-type media it
  coordinates both panes (play/pause, seek, frame-step, zoom, pan sync),
  seekbar length matches the active side while the shorter side holds its
  last frame; only the active side plays audio; resolution/download apply
  to the active side; fullscreen covers the whole compare view.
- Right sidebar (comments/fields) binds to the active side; comment
  selection seeks the active pane and annotations/comments can be created.
- Reuses useFramePlayer + DrawingCanvas without modifying the existing
  single-file video player.
- Unit tests for compare selection/clamp logic.
2026-07-04 10:20:16 +08:00
Yiling-J e7273f1a02 Merge pull request #170 from shumaiOne/feat/video-duration-card-preview
feat(file-browser): show video duration on file card preview
2026-07-03 23:08:03 +08:00
yiling d3efc00902 feat(file-browser): show video duration on file card preview
Display the video duration (mm:ss) in the bottom-right corner of the
video file card preview area with white text and a transparent
background. Duration is sourced from media metadata and exposed via the
preview DTO. The overlay is gated behind a showDuration prop so it only
appears on file cards, not folder card child previews.
2026-07-03 20:48:26 +08:00
Yiling-J 06df7537e0 Merge pull request #169 from shumaiOne/test/video-player-restart-on-end
test(webui): verify video player restarts playback after end
2026-07-03 20:33:04 +08:00
yiling 1de8c4ad32 test(webui): verify video player restarts playback after end
Add an e2e spec covering restart-on-end for the frame-accurate video
player. Drives the real player to its natural end (seek near the tail,
play out the last frames) and asserts both restart triggers resume from
the start: the play/pause control and clicking the video area.

Adds seekToFrame and waitForEnded helpers to VideoPlayerPage.
2026-07-03 20:16:48 +08:00
Yiling-J 278bbdd4fe Merge pull request #168 from shumaiOne/test/video-comment-seek-e2e
test(webui): add frame-accurate comment seek roundtrip e2e
2026-07-03 20:08:13 +08:00
yiling ed40b41e1a test(webui): rework seek-settle wait to avoid overlapping browser polls
Address review feedback: an async predicate with setTimeout inside
page.waitForFunction spawns overlapping executions at rAF rate, and checking
currentTime stability before arrival can resolve prematurely.

Reorder to arrival-first: wait for the target frame via a synchronous rAF-polled
predicate, then wait for currentTime to stabilize using a sequential Node-side
loop so browser evaluations never overlap.
2026-07-03 19:36:39 +08:00
yiling 3dcab584ae test(webui): add frame-accurate comment seek roundtrip e2e
Extend the backend-free video-player harness with the app's real comment↔player
wiring (onTimeUpdate capture, player.currentTime(second) seek on comment click,
and a remount to simulate a second user) and add a Playwright spec.

User A comments on 5 distinct random frames (regenerated each run); user B
reloads and clicks each comment. Asserts the seconds-based roundtrip is
loss-free: frameA -> second=frameA/fps -> seek(second) -> floor(second*fps+0.45)
== frameA, so the comment is stored at the frame the author saw and the reader
lands on that exact frame.
2026-07-03 19:20:17 +08:00
Yiling-J cfbb799ddc Merge pull request #167 from shumaiOne/fix/root-component-conditional-hooks
fix(webui): resolve conditional hooks and setState-in-render errors
2026-07-03 18:59:34 +08:00
yiling 9623da7504 fix(webui): resolve conditional hooks and setState-in-render errors
- __root.tsx: move useTeamContextStore/useEffect/useQuery above the
  conditional 'return <Outlet />' so hooks run unconditionally in a
  stable order (fixes 'Rendered more hooks than during the previous
  render')
- team-selector.tsx: move single-team navigate() into a useEffect to
  avoid updating the router Transitioner during render
2026-07-03 18:53:38 +08:00
Yiling-J 370b0d3050 Merge pull request #166 from shumaiOne/test/video-player-playwright-e2e
test(webui): video player e2e framework + Safari playhead fix
2026-07-03 17:20:51 +08:00
yiling c847649242 docs(webui): update video player design doc for rVFC-gated playhead sync
Reflect the useFramePlayer changes: the currentTime/RAF path only drives the
playhead once rVFC has delivered a frame this session (or is unsupported / a
grace elapsed), pause locks to the last presented mediaTime when fresh, and
document the frame-accurate pause/resume audio-replay tradeoff.
2026-07-03 16:14:19 +08:00
yiling 38694eb77b fix(webui): stop Safari video playhead from rewinding on play/pause
On Safari/WebKit, video.currentTime (the playback clock) runs ahead of the
frame actually presented on screen at playback start, and the first
requestVideoFrameCallback arrives only after a delay. useFramePlayer drove the
playhead from currentTime immediately on play, racing it forward, then snapped
it backward when the first rVFC reported the true (lower) presented frame.

Fix 1 (play-start rewind): reset the per-session VFC state on each play and only
use the currentTime/RAF path when rVFC is unsupported, or has delivered a frame
this session and then stalled (e.g. video track ended while audio continues), or
never delivered within a safety grace. The playhead now follows the actually
presented frame instead of the leading playback clock.

Fix 2 (pause snap): on pause, prefer the last presented mediaTime when rVFC is
fresh so the playhead locks to the frame the user is looking at, instead of
jumping forward to the leading currentTime. Falls back to currentTime when rVFC
is stale/unsupported.

Add a deterministic useFramePlayer hook unit test (happy-dom) that simulates
Safari's leading currentTime and lagging mediaTime; it asserts the playhead is
monotonic on play and locks to the presented frame on pause (both fail on the
old logic), and that the end-of-track currentTime fallback still works.
2026-07-03 15:56:31 +08:00
yiling 8c53685590 chore(webui): remove unused vite dev dependencies
The webui package was migrated from a Vite project but now uses the Bun
fullstack framework (Bun.serve + bun-plugin-tailwind) for dev/prod, and the
e2e harness serves via Bun too. Nothing in webui imports vite, @vitejs/plugin-react,
@tailwindcss/vite or vite-tsconfig-paths (the only vite-tsconfig-paths usage is
the root vitest.config.ts via the root devDependency), so drop them from the
webui package.

Verified: typecheck, lint, vitest and the playwright e2e suite all still pass
(Tailwind compiles via bun-plugin-tailwind).
2026-07-03 14:55:56 +08:00
yiling 469f68b25d test(webui): add playwright e2e framework with video player play/pause test
Add a Playwright UI integration test framework for the frame-accurate video
player. Tests run against a backend-free harness served by Bun's native HTML
bundler (matching the project's Bun-based dev/prod serving), so no database,
auth or transcode pipeline is required.

- Add @playwright/test with chromium/firefox/webkit projects; the browser is
  selectable via the Playwright --project flag (webkit = Safari engine).
- Serve the harness with Bun.serve + bun-plugin-tailwind (no separate Vite
  toolchain); commit a deterministic 16x16/5s/30fps fixture video and matching
  AssetInfo.
- Add a play/pause spec covering both the play control and clicking the video
  area, asserting the native video clock, seekbar fill and frame readout stay
  frame-locked after pause (settle-aware, tolerance-based assertions).
- Mock all backend API calls (anchored /api/ and /files/ routes) for isolation.
- Exclude e2e specs from Vitest; add a separate CI job (webkit on macOS).
2026-07-03 14:50:38 +08:00
yiling 7c3412686c Release v0.1.5 2026-07-02 19:01:12 +08:00
Yiling-J 297c4903fe Merge pull request #165 from shumaiOne/refactor/friendly-storage-filenames
refactor(storage): use original filenames for stored files
2026-07-02 18:18:00 +08:00
yiling b7367bb129 refactor(storage): use original filenames and fix download UX
- Store uploaded files as files/{ulid}/{original-name} instead of files/{ulid}/raw
- Store transcoded videos as {stem}-{resolution}.mp4 (e.g. foo-720p.mp4)
- Store transcoded images as {stem}-{width}p.webp (e.g. foo-1920p.webp)
- Add download?: boolean param to presign - only sets Content-Disposition: attachment when true
- Local storage handler only sets Content-Disposition when ?download=1 query param is present
- Add POST /api/files/download-url endpoint for key-based single file downloads
  - Uses ResourceType.Asset for permission check
  - Validates key belongs to the asset's storage directory
- Fix existing download-links API to pass download: true to presign
- Fix breadcrumb navbar download: video shows resolution submenu, others download directly
- Fix video player download: calls download-url API, shows correct file type label
- Remove filename query param hack from presign URLs
- Add sanitizeFilename() and stemFromKey() utility helpers
- Add key field to VideoTranscode DTO interface
2026-07-02 17:39:23 +08:00
yiling 114cdca4ee update aliyun acr image 2026-07-02 10:51:06 +08:00
Yiling-J 9d7b142129 Improve formatting of commands in README_CN.md
Fix formatting issues in README_CN.md for clarity.
2026-07-02 10:44:57 +08:00
Yiling-J 91fafafeff Merge pull request #164 from shumaiOne/feature/update-release-workflow
ci(release): add Aliyun ACR push to release workflow
2026-07-02 10:10:32 +08:00
yiling d5b9439371 ci(release): add Aliyun ACR push to release workflow 2026-07-02 10:02:13 +08:00
yiling 3725193e72 Release v0.1.4 2026-07-01 20:24:39 +08:00
Yiling-J 62c9fb46ae Merge pull request #163 from shumaiOne/feat/signup-locale
feat(auth): allow setting user locale on signup
2026-07-01 19:29:02 +08:00
yiling 9b1890f57c feat(auth): allow setting user locale on signup 2026-07-01 19:23:49 +08:00
Yiling-J 68a8b67931 Merge pull request #162 from shumaiOne/fix/video-replay
fix(webui): preserve video ended state by skipping playhead snap on ended
2026-07-01 14:56:19 +08:00
yiling d0bda60b9f fix(webui): preserve video ended state by skipping playhead snap on ended 2026-07-01 14:46:12 +08:00
yiling d71b0de056 remove video player debug logs 2026-07-01 14:37:34 +08:00
yiling 8c7d4f5b72 update cn docker setup guide 2026-07-01 14:36:09 +08:00
Yiling-J d8793a89a2 Merge pull request #161 from shumaiOne/feat/video-poster-480p
feat(transcode): change video poster resolution to 480p
2026-07-01 12:55:25 +08:00
yiling 178670fdab feat(transcode): change video poster resolution to 480p 2026-07-01 12:45:16 +08:00
yiling 715b657153 update readme 2026-07-01 12:40:30 +08:00
Yiling-J c0353bb050 Update README_CN.md with English documentation link
Added English link to the README_CN.md file.
2026-07-01 11:14:11 +08:00
Yiling-J 0c1907d868 Add Chinese README link to README.md
Added a link to the Chinese README in the main README.
2026-07-01 11:12:03 +08:00
Yiling-J edbf2c6001 Refine AI feature descriptions in README
Updated descriptions for AI features in README.
2026-07-01 11:04:21 +08:00
Yiling-J fa319d0898 Add Dockerfile syntax version specification 2026-07-01 10:50:37 +08:00
Yiling-J b0a595fe9c Add README_CN.md 2026-07-01 10:44:19 +08:00
Yiling-J b7d250dbac Update README with media processing information
Added note about media processing and storage details.
2026-07-01 09:45:24 +08:00
yiling 2cbc86fdd6 Release v0.1.3 2026-06-30 19:01:50 +08:00
Yiling-J d391705519 Merge pull request #160 from shumaiOne/fix/team-settings-video-strategy
fix(api): fix update team settings and make request schema type-safe
2026-06-30 15:18:39 +08:00
yiling 34a69a33bf fix(api): fix update team settings and make request schema type-safe 2026-06-30 14:41:50 +08:00
Yiling-J d32707d038 Merge pull request #159 from shumaiOne/fix/file-detail-parent-folder
fix(webui): fix missing left sidebar for nested folders
2026-06-30 13:11:06 +08:00
yiling 89777e0b6d fix(webui): fix missing left sidebar for nested folders 2026-06-30 13:00:18 +08:00
Yiling-J 8b800bc792 Merge pull request #158 from shumaiOne/fix/video-player-duration
fix(webui): align video timeline duration and formatting with frameio
2026-06-30 11:35:14 +08:00
yiling 899b600417 fix(webui): resolve 1-frame comment mismatch via 0.45 offset and pause snapping 2026-06-30 11:10:53 +08:00
yiling 954d8ee497 docs(webui): update video player design doc with Zoom Fit section 2026-06-30 10:50:39 +08:00
yiling 86ad68a705 feat(webui): add Fit zoom button in video player control bar 2026-06-30 10:50:30 +08:00
yiling d2ee7f1c45 fix(webui): prevent initial scale fit layout race condition 2026-06-30 10:45:51 +08:00
yiling 7cb1aa3c86 docs(webui): add video player design document 2026-06-30 10:34:19 +08:00
yiling 1704fddc67 refactor(webui): use Floor with Epsilon (0.001) for frame conversion calculations 2026-06-30 10:22:32 +08:00
yiling 07d82377bd fix(webui): implement dynamic stall threshold for requestVideoFrameCallback 2026-06-30 09:47:13 +08:00
yiling 9c8f29e3ba fix(webui): unify playhead loop with requestAnimationFrame to prevent deadlock 2026-06-29 20:33:24 +08:00
yiling 9fd707b23f fix(webui): fallback to requestAnimationFrame when video track freezes 2026-06-29 20:16:06 +08:00
yiling 14f6752de2 fix(webui): align video timeline duration and formatting with frameio 2026-06-29 19:48:28 +08:00
Yiling-J b75b276908 Merge pull request #157 from shumaiOne/refactor-video-accurate-seek
feat(video): add frame-accurate video player, SMPTE timecodes, and format switcher
2026-06-29 16:57:07 +08:00
yiling 95f91cd4de feat(db): add custom migration to backfill totalFrames and startTimecode 2026-06-29 11:27:32 +08:00
yiling bb65c5a0d3 perf(video): optimize keydown listener binding in useFramePlayer 2026-06-29 11:01:10 +08:00
yiling a585718660 fix(video): add fallback timeout to seeked Promise wrapper to prevent permanent freeze 2026-06-29 10:58:34 +08:00
yiling adb5f58535 fix(transcode): replace isNaN with isFinite to guard against Infinity frameRate 2026-06-29 10:55:28 +08:00
yiling 9ca9b2d8e4 fix(video): safely sync startTime seek with VideoJS loadedmetadata status 2026-06-29 10:53:14 +08:00
yiling b173b4910e test(video): extract calculateFrameCenterTime helper and add unit tests 2026-06-29 10:10:47 +08:00
yiling 9576453a72 fix(video): display totalFrames - 1 as duration to align timer at end 2026-06-29 10:02:17 +08:00
yiling 5233615720 fix(video): add centralized playhead nudge for boundary-accurate seeking 2026-06-28 23:22:03 +08:00
yiling 1ebf79edd3 fix(video): resolve 1-frame shift on external seeks due to floor rounding 2026-06-28 21:12:29 +08:00
yiling eee7b5a677 feat(video): add SMPTE timecode support and format selection dropdown 2026-06-28 21:04:40 +08:00
yiling 837fe5bd7a feat(video): add frame-accurate video player and CFR proxy generation 2026-06-28 20:35:47 +08:00
Yiling-J f159fec693 Merge pull request #156 from shumaiOne/feat/i18n-webui
feat(webui): add i18n support using paraglide-js
2026-06-27 15:51:52 +08:00
yiling dc46853582 chore: mark prisma and paraglide generated folders as linguist-generated 2026-06-27 15:00:47 +08:00
yiling 850b1ff667 feat(webui): integrate i18n into file-browser context-menu component 2026-06-27 14:55:25 +08:00
yiling 4475c7bed6 feat(webui): integrate i18n into share-settings-sidebar component 2026-06-27 14:53:09 +08:00
yiling 0fd826b973 feat(webui): integrate i18n into share-manager component 2026-06-27 14:50:17 +08:00
yiling 2d5b4a3753 feat(webui): integrate i18n into project-dialog component 2026-06-27 14:47:31 +08:00
yiling fb63d8b7b6 feat(webui): translate formatCount in file-browser and add plural keys 2026-06-27 14:45:30 +08:00
yiling 7182c00c7d feat(webui): integrate i18n into fields-manager and manage-fields-dialog components 2026-06-27 14:41:47 +08:00
yiling e8058a2292 feat(webui): integrate i18n into folder-tree component and add missing translation keys 2026-06-27 14:30:22 +08:00
yiling 1b60c8df83 feat(webui): integrate i18n into search and sort control components 2026-06-27 10:30:57 +08:00
yiling 4dc53063ea chore: add paraglide generated folders to prettier ignore files 2026-06-27 10:24:20 +08:00
yiling d5dbb3c01b chore(deps): install paraglide-js dev dependency in root and configure compile scripts 2026-06-27 10:20:00 +08:00
yiling 8779ae52a2 fix(webui): rename arguments translation key to tool_arguments to avoid strict mode reserved word error 2026-06-27 10:14:16 +08:00
yiling 5c21463075 feat(webui): complete webui translations and integrate i18n 2026-06-27 10:12:07 +08:00
yiling 914855a25c chore(webui): move paraglide directory to packages/webui root and update imports 2026-06-26 13:35:27 +08:00
Yiling-Jandgemini-code-assist[bot] c7b0346782 Apply suggestions from code review
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2026-06-26 13:28:53 +08:00
yiling e6818860da chore: ignore markdown files in Prettier 2026-06-26 13:28:00 +08:00
yiling 5dae5740e3 chore(webui): revert formatting changes in root README.md 2026-06-26 13:27:04 +08:00
yiling bbe36a028d ci: revert Compile translations step from CI workflows 2026-06-26 12:24:41 +08:00
yiling ba5f7296a8 chore(i18n): commit generated paraglide code and disable output gitignore 2026-06-26 12:10:37 +08:00
yiling cd4a22d20b ci: compile i18n translations before running lint and typecheck 2026-06-26 11:52:09 +08:00
yiling fc7d1452b0 fix(webui): resolve team ID using target location pathname in beforeLoad 2026-06-26 11:48:38 +08:00
yiling 4fd27ab147 feat(webui): add i18n text keys and translate one static text element per page for verification 2026-06-26 11:24:32 +08:00
yiling 6e2e5bdbc2 refactor(webui): extract shared resolveTeamIdFromPath function for root route and component 2026-06-26 11:18:09 +08:00
yiling b6ff60f8b8 docs: add paraglide-js i18n rules and usage guide to AGENTS.md 2026-06-26 10:44:49 +08:00
yiling 48f4c83cc8 feat(webui): add i18n support using paraglide-js 2026-06-26 10:39:32 +08:00
Yiling-J 81b0083672 Fix formatting for AWS_ENDPOINT_URL_S3 example 2026-06-25 20:38:21 +08:00
yiling 3737418ec3 Release v0.1.2 2026-06-25 19:43:07 +08:00
Yiling-J 6d47ea7466 Update AWS_ENDPOINT_URL_S3 explanation in README
Clarified the default value for AWS_ENDPOINT_URL_S3 and its usage with custom host/port.
2026-06-25 19:15:11 +08:00
Yiling-J 84d96ff83a Revise README for environment variable setup
Updated environment variable configuration instructions for clarity and added optional settings for S3-compatible storage.
2026-06-25 19:11:39 +08:00
Yiling-J 6e985aed61 Merge pull request #155 from shumaiOne/refactor/s3-endpoint
refactor(s3): remove automatic port appending to AWS_ENDPOINT_URL_S3
2026-06-25 18:56:49 +08:00
yiling 8347a9ca15 docs(docker): document SHUMAI_SERVER_PORT and update local docker-compose env 2026-06-25 18:50:29 +08:00
yiling ab9b33320d docs(s3): document SHUMAI_SERVER_PORT and S3 endpoint port configurations 2026-06-25 18:48:23 +08:00
yiling efd6163238 refactor(s3): remove automatic port appending to AWS_ENDPOINT_URL_S3 2026-06-25 18:46:14 +08:00
yiling 0e4bdec0e3 Release v0.1.1 2026-06-23 10:32:41 +08:00
yiling 0eb03b16a4 chore(docker): add AWS_ENDPOINT_URL_S3 to local docker-compose 2026-06-23 10:27:18 +08:00
Yiling-J b216773044 Merge pull request #151 from shumaiOne/docker/entrypoint-privilege-dropping
feat(docker): add root entrypoint with privilege dropping for data volumes
2026-06-23 10:09:57 +08:00
yiling 92801ba14a fix(core): make version stack sort index lookup deterministic
When creating a version stack, the sortIndex was previously extracted
by taking files[0] from the database query result. Because findMany
without orderBy is non-deterministic, this resulted in flakiness
where the sortIndex would sometimes be null (from file2) instead of
'abc' (from file1), causing tests to fail.

We now look up the first file specifically based on the ordered
fileIds array parameter.
2026-06-23 10:02:01 +08:00
yiling 661e836f06 fix(docker): support non-root/restricted container environments in entrypoint
Checks if the container is running as root (UID 0) before executing
chown and gosu. If running directly as a non-root user (e.g. in hardened
environments like Kubernetes runAsNonRoot or via docker run --user),
it directly execs the command, preventing EACCES and permission errors.
2026-06-23 09:56:31 +08:00
yiling fb5c7ecabe chore(docker): ignore dist and data directories in .dockerignore
This adds the `dist` and `data` folders to `.dockerignore` to prevent
them from being transferred as part of the Docker build context.
This reduces the build context size by over 1.5GB+, making the build
much faster.
2026-06-23 09:53:00 +08:00
yiling a390643458 feat(docker): add root entrypoint with privilege dropping for data volumes
This updates the Dockerfile and adds a scripts/docker-entrypoint.sh script.
Under native Linux (like Debian), when docker-compose mounts a host folder
as a volume (e.g. `./data:/app/data`), and the folder doesn't exist, the
docker daemon creates the folder as root-owned (`root:root`).

Because the container runs as a non-root user `bun`, it gets permission
denied (`EACCES`) when trying to write to the data directory.

To resolve this in a beginner-friendly way without manual host-side
permissions updates:
1. The runner stage now installs `gosu`.
2. At the end of the Dockerfile, the user switches back to `root` so the
   container launches as root.
3. On launch, the entrypoint script executes. Since it runs as root, it
   automatically changes ownership of `/app/data` to `bun:bun`.
4. The entrypoint script then uses `gosu` to drop privileges and launch the
   actual server processes as the non-root `bun` user.
2026-06-23 09:46:56 +08:00
yiling 9325c71b51 Release v0.1.0 2026-06-22 21:45:39 +08:00
Yiling-J 2f746d3ce8 Merge pull request #150 from shumaiOne/feat/secure-share-info
feat(share): secure share info API and fix wrong password feedback
2026-06-22 20:53:56 +08:00
yiling bdceda4cb6 refactor(share): use custom strongly-typed error classes 2026-06-22 20:48:47 +08:00
yiling df6e392bf6 feat(share): expose raw password on settings page 2026-06-22 20:32:46 +08:00
yiling 48b2047a84 feat(share): secure share info API and fix wrong password feedback 2026-06-22 20:21:44 +08:00
yiling 2b360b2b2c chore(docker): update shumai image tag to latest 2026-06-22 15:52:00 +08:00
Yiling-J 5d19e6ddfa Merge pull request #149 from shumaiOne/fix-sidebar-overflow
fix(webui): truncate long folder, collection, and share link names in sidebar
2026-06-22 15:46:18 +08:00
yiling 5e70b6f3ee docs: add note blocks for running binaries under Bun runtime 2026-06-22 15:39:47 +08:00
yiling 8eab02ab28 fix(webui): truncate long folder, collection, and share link names in sidebar 2026-06-22 15:22:44 +08:00
yiling 7aa347df92 Release v0.0.11 2026-06-22 14:38:28 +08:00
Yiling-J 5d6462adf0 Merge pull request #148 from shumaiOne/rename-npm-cli-package
chore(cli): rename npm package to @shumai-one/shumai-cli
2026-06-22 14:21:59 +08:00
yiling 5f1e0c1823 chore(cli): rename npm package to @shumai-one/shumai-cli 2026-06-22 14:16:47 +08:00
Yiling-J d8381dff21 Merge pull request #147 from shumaiOne/feat/user-custom-fields
feat(metadata): add single user and multiple user custom fields
2026-06-22 12:01:41 +08:00
yiling b6519431db docs(metadata): document new user custom field types 2026-06-22 11:55:53 +08:00
yiling 02fddf8ebd chore: ignore generated prisma folder in prettier 2026-06-22 11:54:56 +08:00
yiling f4c52d9273 chore(db): migrate generate script to root package.json under db:generate 2026-06-22 11:49:53 +08:00
yiling 77093aa294 fix(webui): lock user-field height and suppress benign ResizeObserver limit warnings 2026-06-22 11:40:48 +08:00
yiling 4806c63906 feat(metadata): add single user and multiple user custom fields 2026-06-22 11:27:00 +08:00
Yiling-J 14d04e9d77 Merge pull request #146 from shumaiOne/feat/auto-expand-folders
feat(folders): auto expand folder tree in left sidebar on navigation
2026-06-22 11:02:14 +08:00
yiling 342cdcdd06 style(folders): fix selection highlight overlap by increasing padding 2026-06-22 10:52:25 +08:00
yiling 98a76e913b style(folders): use Shadcn ScrollArea in left sidebar containers 2026-06-22 10:44:07 +08:00
yiling 2240901d55 feat(folders): auto expand folder tree in left sidebar on navigation 2026-06-22 10:27:21 +08:00
Yiling-J 6892967993 Merge pull request #145 from shumaiOne/feat/agent-settings-singular-ui
feat(settings): use singular headers and remove collapse/counters for single agent types
2026-06-22 10:10:16 +08:00
yiling 7ea5345c52 refactor(settings): dynamically render thinkingLevel dropdown from schema options 2026-06-22 10:04:51 +08:00
yiling bea81a207a fix(settings): support type-safe thinkingLevel and propagate to AgentHarness 2026-06-22 09:58:35 +08:00
yiling c20ef0e4b6 fix(settings): prioritize actual agent type when editing agent configurations 2026-06-22 09:27:37 +08:00
yiling 754131f13a feat(settings): support singular headers and remove collapse/counters for single agent types 2026-06-22 09:23:13 +08:00
Yiling-J 6981706e13 Merge pull request #144 from shumaiOne/feat/shumai-cli
feat(cli): add shumai-cli and token authentication
2026-06-21 23:16:39 +08:00
yiling 280c06b68c docs(cli): move CLI section to the bottom of the root README 2026-06-21 21:56:52 +08:00
yiling 4e21becbe0 docs(cli): add CLI documentation and link to it in root README 2026-06-21 21:54:45 +08:00
yiling 86c1d964a3 feat(cli): add create-version command 2026-06-21 20:14:26 +08:00
yiling 87fc10b62f fix(cli): resolve upload status and CLI progress tracker bugs 2026-06-21 20:06:06 +08:00
yiling 7d91d70a14 feat(cli): add @shumai/tableprinter package to handle terminal-friendly table layouts 2026-06-21 19:28:31 +08:00
yiling 1c994adce9 build(cli): bundle hono and ulid directly into the CLI script for zero dependency distribution 2026-06-21 19:15:41 +08:00
yiling afd55eca85 chore(cli): add @shumai-one/cli to local release testing script 2026-06-21 19:06:12 +08:00
yiling 29e3d3ae03 refactor(cli): rename shumai-cli folder to cli and integrate packaging script 2026-06-21 19:00:38 +08:00
yiling 90ef063d43 feat(cli): add shumai-cli and token authentication 2026-06-21 12:35:12 +08:00
yiling e33cbdb37c Release v0.0.10 2026-06-21 10:52:57 +08:00
Yiling-J 0514a19702 Merge pull request #143 from shumaiOne/docs/polish-readme
docs(readme): polish structure, correct grammar, and add dependencies table
2026-06-21 10:45:04 +08:00
Yiling-Jandgemini-code-assist[bot] 9fb9e608b9 Update README.md
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
2026-06-21 10:44:45 +08:00
yiling cbb25b49e7 docs(readme): add daemon commands documentation under option 2 2026-06-21 10:34:15 +08:00
yiling ce8fc5d128 docs(readme): polish structure, correct grammar, and add dependencies table 2026-06-21 10:24:23 +08:00
Yiling-J 34bacf5421 Merge pull request #142 from shumaiOne/refactor/prod-routes
refactor(web): dynamically register production HTML bundle routes
2026-06-21 09:25:56 +08:00
yiling 98bbfa51ae refactor(web): dynamically register production HTML bundle routes 2026-06-21 00:20:41 +08:00
901 changed files with 264215 additions and 57045 deletions
+4 -1
View File
@@ -1,4 +1,6 @@
node_modules
dist
data
Dockerfile*
docker-compose*
.dockerignore
@@ -12,4 +14,5 @@ helm-charts
.env
.editorconfig
.idea
coverage*
coverage*
packages/webui/paraglide
+2 -1
View File
@@ -1 +1,2 @@
src/generated/** linguist-generated
packages/db/src/generated/** linguist-generated
packages/webui/paraglide/** linguist-generated
+164 -3
View File
@@ -22,9 +22,9 @@ jobs:
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v1
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
bun-version: 1.4.2
- name: Install dependencies
run: bun install
@@ -32,7 +32,10 @@ jobs:
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ripgrep bubblewrap socat
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
- name: Compile i18n
run: bun run i18n:compile
- name: Lint
run: bun run lint
@@ -55,3 +58,161 @@ jobs:
echo "Smoke testing shumai-transcode..."
bun run /tmp/shumai-local-release/node/node_modules/@shumai-one/shumai-transcode/bin/shumai-transcode-app.js --check
e2e_video_player:
name: Harness E2E (${{ matrix.project }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
project: chromium
- os: ubuntu-latest
project: firefox
# WebKit is the Safari engine; run it on a macOS runner to validate
# Safari compatibility.
- os: macos-latest
project: webkit
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.4.2
- name: Install dependencies
run: bun install
- name: Compile i18n
run: bun run i18n:compile
- name: Install Playwright browser (${{ matrix.project }})
run: bunx playwright install --with-deps ${{ matrix.project }}
- name: Run video player harness tests
env:
E2E_SKIP_APP_SERVER: true
run: bunx playwright test --project=harness-${{ matrix.project }}
- name: Upload Playwright report
if: ${{ !cancelled() }}
uses: actions/upload-artifact@v4
with:
name: playwright-report-harness-${{ matrix.project }}
path: playwright-report/
retention-days: 7
e2e_app:
name: App E2E (${{ matrix.project }})
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
project: chromium
- os: ubuntu-latest
project: firefox
# App E2E needs Docker for testcontainers, run webkit on Ubuntu
- os: ubuntu-latest
project: webkit
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.4.2
- name: Install dependencies
run: bun install
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
- name: Compile i18n
run: bun run i18n:compile
- name: Install Playwright browser (${{ matrix.project }})
run: bunx playwright install --with-deps ${{ matrix.project }}
- name: Run app E2E tests
run: bunx playwright test --project=app-${{ matrix.project }} --no-deps
- name: Upload Playwright report
if: ${{ !cancelled() }}
uses: actions/upload-artifact@v4
with:
name: playwright-report-app-${{ matrix.project }}
path: playwright-report/
retention-days: 7
workflow_e2e:
name: Workflow E2E
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: 1.4.2
- name: Install dependencies
run: bun install
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick
- name: Run Workflow E2E Tests
run: bun run test:e2e:workflow
docker_compose_deploy:
name: Docker Compose Deployment
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Build Docker Image
run: |
docker build -t shumaione/shumai:latest .
- name: Start Docker Compose
run: |
docker compose -f docker-compose/local/docker-compose.yaml up -d
- name: Verify Home Page HTTP 200
run: |
echo "Waiting for shumai_app container to start..."
for i in {1..30}; do
STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" http://localhost:3000 || true)
echo "Attempt $i: HTTP status code $STATUS_CODE"
if [ "$STATUS_CODE" -eq 200 ]; then
echo "✅ Docker compose app is running cleanly (HTTP 200 OK)"
exit 0
fi
sleep 2
done
echo "❌ Container failed to respond with HTTP 200 OK within 60s"
echo "--- Container Logs ---"
docker compose -f docker-compose/local/docker-compose.yaml logs
exit 1
- name: Cleanup Docker Compose
if: always()
run: |
docker compose -f docker-compose/local/docker-compose.yaml down -v
+31 -4
View File
@@ -36,7 +36,7 @@ jobs:
- name: Setup Bun
uses: oven-sh/setup-bun@v2
with:
bun-version: latest
bun-version: 1.4.2
- name: Setup Node.js
uses: actions/setup-node@v6
@@ -48,11 +48,14 @@ jobs:
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y ripgrep bubblewrap socat libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev fd-find
sudo apt-get install -y ripgrep bubblewrap socat ffmpeg poppler-utils imagemagick libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev fd-find
- name: Install dependencies
run: bun install
- name: Compile i18n
run: bun run i18n:compile
- name: Lint
run: bun run lint
@@ -65,18 +68,42 @@ jobs:
- name: Build NPM packages
run: bun run build-npm
- name: Generate release notes
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
CHANGELOG_NOTES=$(bun run scripts/extract-changelog.ts "${{ env.RELEASE_TAG }}" 2>/dev/null || true)
PR_NOTES=$(gh api "repos/${{ github.repository }}/releases/generate-notes" -f tag_name="${{ env.RELEASE_TAG }}" --jq .body 2>/dev/null || true)
{
if [ -n "$CHANGELOG_NOTES" ]; then
echo "$CHANGELOG_NOTES"
echo ""
echo "---"
echo ""
fi
if [ -n "$PR_NOTES" ]; then
echo "$PR_NOTES"
fi
} > /tmp/release-notes.md
- name: Create GitHub Release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
if [ ! -s /tmp/release-notes.md ]; then
NOTES_FLAG="--generate-notes"
else
NOTES_FLAG="--notes-file /tmp/release-notes.md"
fi
if gh release view "${{ env.RELEASE_TAG }}" >/dev/null 2>&1; then
gh release edit "${{ env.RELEASE_TAG }}" \
--title "${{ env.RELEASE_TAG }}" \
--generate-notes
$NOTES_FLAG
else
gh release create "${{ env.RELEASE_TAG }}" \
--title "${{ env.RELEASE_TAG }}" \
--generate-notes
$NOTES_FLAG
fi
- name: Upgrade npm for trusted publishing
+12 -1
View File
@@ -27,12 +27,22 @@ jobs:
username: shumaione
password: ${{ secrets.DOCKERHUB_TOKEN }}
# Log in to Aliyun ACR
- name: Log in to Aliyun ACR
uses: docker/login-action@v3
with:
registry: crpi-000nkafzu6xvpwsc.cn-hongkong.personal.cr.aliyuncs.com
username: njjyl723
password: ${{ secrets.ALI_ACR_TOKEN }}
# Extract metadata (tags, labels) for Docker
- name: Extract metadata (tags, labels) for Docker
id: meta
uses: docker/metadata-action@v5
with:
images: shumaione/shumai
images: |
shumaione/shumai
crpi-000nkafzu6xvpwsc.cn-hongkong.personal.cr.aliyuncs.com/shumai-one/shumai
tags: |
type=semver,pattern={{version}}
type=ref,event=branch
@@ -44,5 +54,6 @@ jobs:
platforms: linux/amd64,linux/arm64
context: .
push: true
provenance: false
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
+14
View File
@@ -2,6 +2,8 @@ node_modules
.bun
dist
out
*.ccx
!apps/premiere-uxp/shumai-premiere.ccx
.DS_Store
*.log
.env
@@ -11,3 +13,15 @@ data/
*.db
*.diff
*.orig
code_quality.md
.agents
# Playwright
/playwright-report/
/test-results/
/blob-report/
/playwright/.cache/
# Paraglide JS
packages/webui/paraglide
+6 -1
View File
@@ -2,4 +2,9 @@ node_modules
dist
.bun
src/generated
src/ui/components/ui
packages/db/src/generated
packages/core/src/generated
src/ui/components/ui
packages/webui/paraglide
*.md
**/*.md
+92 -4
View File
@@ -14,9 +14,10 @@ Complete the task on that branch.
After finishing the work and verifying that all checks pass:
1. Stage and commit your changes.
2. Push the branch to `origin`.
3. Open a pull request using the GitHub CLI.
1. Update `CHANGELOG.md` under `## [Unreleased]` for user-facing changes (see [Changelog Guidelines](#changelog-guidelines)).
2. Stage and commit your changes.
3. Push the branch to `origin`.
4. Open a pull request using the GitHub CLI.
```bash
git add .
@@ -61,6 +62,19 @@ https://www.conventionalcommits.org/en/v1.0.0/#summary
---
## Changelog Guidelines
We maintain `CHANGELOG.md` following [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
Before opening a pull request, add an entry under `## [Unreleased]` for any user-facing changes:
- **End-User Friendly**: Make entries easy to understand for end users. For new features, explain what they actually do in plain language without heavy technical jargon. For bug fixes, describe what the bug was in a friendly, relatable way rather than focusing on internal code mechanics, file paths, or private symbols.
- **Formatting**: `- **<scope>**: <Description>` (e.g. `- **asset**: Fix an issue where moving a video to trash while it was still transcoding could cause it to lose its trashed status`).
- **No PR Numbers**: Do not include PR numbers or links; the release pipeline automatically appends the detailed PR list.
- **Internal Changes**: Routine refactors, test additions, or internal chores without external behavior changes may omit changelog updates.
---
## Pull Request Template
```md
@@ -90,6 +104,9 @@ Add any additional context, caveats, or follow-up work.
- `bun run format`
- `bun run typecheck`
- `bun run test`
- `bun run test:e2e:app`
- `bun run test:e2e:webui`
- `bun run test:e2e:workflow`
- **Backend Testing Mandate**: Every backend feature, service method, workflow, and activity MUST be accompanied by comprehensive tests. Logic-heavy code without corresponding test coverage is considered incomplete.
@@ -139,7 +156,7 @@ We follow Bun's monorepo conventions for dependency management:
3. **Local DevDependencies**: Tools specific to a single package (e.g., `@vitejs/plugin-react` for `webui`) should be declared in that package's local `package.json`.
4. **Workspace Imports**: Use `workspace:*` for internal package dependencies.
5. **Clean Root**: The root `package.json` must not contain runtime `dependencies`. It is reserved for shared `devDependencies` and workspace-wide `scripts`.
6. **Installation**: Always run `bun install` from the root. Use the `--filter` flag if you only want to update a specific package (e.g., `bun install --filter @shumai/webui`).
6. **Adding Packages**: Never edit `package.json` manually to add new dependencies. Always use `bun add` (e.g., `bun add <package> --filter <workspace>`) from the root without specifying an explicit version, letting Bun resolve the correct version.
## TypeScript Configuration
@@ -196,10 +213,15 @@ The frontend is built with:
- **Prefer System Colors**: Always prefer using semantic system color design tokens (e.g., `bg-background`, `text-foreground`, `text-sidebar-primary`, `text-muted-foreground`, etc.) over hardcoded color utilities (e.g., `bg-blue-50`, `text-emerald-600`, `bg-emerald-500`). This ensures seamless compatibility with light and dark themes.
### Route Code-Splitting
To optimize initial bundle size, all routes must be code-split into `[route].tsx` (lightweight route definition and loaders) and `[route].lazy.tsx` (UI component and heavy imports).
### Development
- **Run Dev**: `bun run dev` (Runs on port 3000)
## Testing
We use **Vitest** for testing (via `bun run test`). **Do not use `bun test`** as it uses Bun's native test runner which is not compatible with this project's test suite.
@@ -267,6 +289,21 @@ describe('Team API', () => {
})
```
### Workflow E2E Tests
- Located in `packages/e2e/workflow/**/*.test.ts`.
- Run via `bun run test:e2e:workflow` (which executes tests against both `local` and `temporal` executors dynamically).
- **Mandatory test coverage**: When creating or updating workflows or activities, you MUST create or update the corresponding E2E tests.
- **Mocking**: Mock ONLY AI API calls. Do not mock S3, databases, or media/transcode extraction services.
- Mock the AI response by spying on `AgentHarness.prototype.prompt`:
### Web App E2E Tests
- Located in `apps/web/e2e/**/*.spec.ts`, organized by domain under `tests/<domain>/` (e.g. `auth`, `project`).
- Run via `bun run test:e2e:app`.
- **Fixtures**: Use the `owner`, `project`, and `file` fixtures for setup — they seed data through API calls/DB (no slow UI setup). You can add more fixtures if necessary.
- **Documentation**: Every test case MUST be documented in [`apps/web/e2e/README.md`](apps/web/e2e/README.md). Add or update the corresponding entry in the README whenever you add, rename, or remove a spec.
## Prisma Configuration & Migrations
- Schema: `packages/db/prisma/schema.prisma`
@@ -299,6 +336,9 @@ We use `prisma-json-types-generator` to enforce strict type-safety for Prisma `J
- Development: Use `bun --bun run prisma migrate dev` to create and apply migrations during development.
- Production: Use `bun --bun run prisma migrate deploy` to apply pending migrations in production environments.
- **No Manual DDL Creation**: Never hand-write **schema (DDL) migration** files or directories. Always generate them with Prisma CLI (`bun --bun run prisma migrate dev --create-only` to create a template, then edit it if needed, or `bun --bun run prisma migrate dev` to apply) so Prisma correctly tracks migration metadata and checksums.
- **Data Migrations Are Allowed**: Pure **data migration** SQL (no schema change) may be written by hand, but it MUST live inside a migration generated via `bun --bun run prisma migrate dev --create-only` so it is tracked and applied automatically.
- **No Automatic Dev DB Reset**: Do not run `prisma migrate reset --force` or commands that force-reset the database automatically. If migrations become out of sync or a reset is required, stop executing, report the situation to the user, and present suggested manual cleanup/reset steps for the user to execute.
### Commands
@@ -408,3 +448,51 @@ We use **pino** for logging. Always use **structured logging** to ensure logs ar
logger.info({ userId: user.id, projectId }, 'Project deleted successfully')
```
- **Levels**: Use appropriate levels: `debug`, `info`, `warn`, `error`.
## Internationalization (i18n)
All user-facing text in the WebUI (`packages/webui`) MUST be internationalized using **Paraglide JS**. Hardcoded text in UI components is strictly forbidden.
### Message Definition
1. Define your English message strings in [packages/webui/messages/en.json](packages/webui/messages/en.json).
2. Define the corresponding Chinese translation strings in [packages/webui/messages/zh.json](packages/webui/messages/zh.json).
3. Keys should use `snake_case`.
Example (`en.json`):
```json
{
"my_key": "My English Text"
}
```
### Compilation
When you add or update translation keys, you must compile them to regenerate the type-safe functions:
```bash
# Compile once (generates type-safe TS/JS functions on disk)
bun run i18n:compile
# Watch and recompile on change during development
bun run i18n:watch
```
### Usage in Components
Import the compiled message namespace `m` and call it as a function:
```typescript
import { m } from '@/ui/paraglide/messages.js'
export function MyComponent() {
return (
<div>
<h1>{m.my_key()}</h1>
</div>
)
}
```
Always use the absolute workspace alias path `@/ui/paraglide/messages.js` (or `runtime.js` for runtime features) when importing Paraglide outputs.
+715
View File
@@ -0,0 +1,715 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [Unreleased]
### Added
### Fixed
### Changed
## [0.4.7] - 2026-09-19
### Added
- **changelog**: Introduce Keep a Changelog support, historical release summaries, and automated release notes extraction
- **release**: Automatically populate GitHub release bodies from CHANGELOG.md and promote unreleased notes during version bumps
- **settings**: Add FFmpeg threads slider to team media processing settings
- **asset**: Show previews of a folder's contents and a "days left" countdown for each item in Recently Deleted
- **asset**: Show the poster and hover preview for a video in the file list while it is still transcoding, with a gently pulsing cover (or an animated waiting circle before the poster is ready), "Uploading..."/"Preparing..." labels, and the duration hidden until it is ready
### Fixed
- **asset**: Fix an issue where moving a video to trash while it was still transcoding could cause it to lose its trashed status
- **transcode**: Immediately stop background video processing and transcoding when a file is permanently deleted from the trash
- **asset**: Fix proxy download filename using original file extension instead of proxy extension
- **asset**: Fix an issue where deleting or restoring a version stack from the file list did nothing
- **webui**: Center breadcrumb file action popup menu on the chevron icon
## [0.4.6] - 2026-09-17
### Added
- **comment**: Add emoji reaction support for comments ([#405](https://github.com/shumaiOne/shumai/pull/405))
- **premiere-uxp**: Introduce Adobe Premiere Pro UXP plugin for Shumai ([#407](https://github.com/shumaiOne/shumai/pull/407))
- **settings**: Add team appearance setting to hide agent features ([#411](https://github.com/shumaiOne/shumai/pull/411))
### Fixed
- **premiere-uxp**: Preserve remote cloud storage presigned URLs in asset resolution ([#408](https://github.com/shumaiOne/shumai/pull/408))
- **premiere-uxp**: Scope sequence links by server endpoint and surface sync errors ([#409](https://github.com/shumaiOne/shumai/pull/409))
- **api**: Enforce SHUMAI_DEMO_MODE for API token and CLI requests ([#413](https://github.com/shumaiOne/shumai/pull/413))
### Documentation
- Add NLE export and Premiere Pro UXP plugin documentation ([#412](https://github.com/shumaiOne/shumai/pull/412))
## [0.4.5] - 2026-09-13
### Added
- **core**: Export comments to FCP, Premiere, Media Composer, and Resolve ([#400](https://github.com/shumaiOne/shumai/pull/400))
- **webui**: Add NLE comments export and migrate export API to POST ([#401](https://github.com/shumaiOne/shumai/pull/401))
- **webui**: Add space key quick preview for files and folders ([#402](https://github.com/shumaiOne/shumai/pull/402))
- **webui**: Show comments count badge in file card preview area ([#403](https://github.com/shumaiOne/shumai/pull/403))
- **agent**: Use deterministic storage keys for preset avatars ([#404](https://github.com/shumaiOne/shumai/pull/404))
## [0.4.4] - 2026-09-09
### Added
- **upload**: S3 multipart upload with offline resume and wake lock ([#391](https://github.com/shumaiOne/shumai/pull/391))
- **transcode**: Optimize video operations using ffmpeg http range requests ([#393](https://github.com/shumaiOne/shumai/pull/393))
- **agent**: Enable read_asset tool for autofill agent ([#396](https://github.com/shumaiOne/shumai/pull/396))
- **sandbox**: Abstract SandboxService and hot-reload allowed domains ([#398](https://github.com/shumaiOne/shumai/pull/398))
### Fixed
- **s3**: Stream downloadToFile and putObject to prevent OOM on large files ([#392](https://github.com/shumaiOne/shumai/pull/392))
- **agent**: Pass agent thinkingLevel to session name generation ([#395](https://github.com/shumaiOne/shumai/pull/395))
- **agent**: Restrict pageCount and duration recommendations to matching media types ([#397](https://github.com/shumaiOne/shumai/pull/397))
- **transcode**: Co-locate screenshots and derived artifacts in asset storage directory ([#399](https://github.com/shumaiOne/shumai/pull/399))
## [0.4.3] - 2026-09-06
### Added
- **asset**: Record and display agent provenance on assets and audit logs ([#380](https://github.com/shumaiOne/shumai/pull/380))
- **agent**: Store preset avatars as real files in s3 storage ([#381](https://github.com/shumaiOne/shumai/pull/381))
- **agent**: Add built-in image and video generation tools and settings ([#382](https://github.com/shumaiOne/shumai/pull/382))
- **media-generation**: Add gemini-omni-1.1-flash video model and redesign settings UI ([#383](https://github.com/shumaiOne/shumai/pull/383))
- **settings**: Redesign image/video settings to provider dialog with model toggles ([#385](https://github.com/shumaiOne/shumai/pull/385))
- **agent**: Add asset management tools and CLI commands ([#387](https://github.com/shumaiOne/shumai/pull/387))
- **cli**: Control asset deletion via SHUMAI_ALLOW_DELETE env var ([#388](https://github.com/shumaiOne/shumai/pull/388))
### Fixed
- **webui**: Clamp file card creation info to 2 lines and show tooltip on hover ([#390](https://github.com/shumaiOne/shumai/pull/390))
### Documentation
- **agents**: Add documentation for image and video generation settings ([#389](https://github.com/shumaiOne/shumai/pull/389))
### Maintenance
- **deps**: Upgrade bun to 1.4.2 and update packages ([#384](https://github.com/shumaiOne/shumai/pull/384))
- **i18n**: Update paraglide-js to 2.25.0 and stop checking in generated code ([#386](https://github.com/shumaiOne/shumai/pull/386))
## [0.4.2] - 2026-09-03
### Added
- **chat**: Support markups, attachments, and timestamps in agent 1-to-1 chat ([#368](https://github.com/shumaiOne/shumai/pull/368))
- **agent**: Move thread metadata to structured context XML ([#373](https://github.com/shumaiOne/shumai/pull/373))
- **agent**: Improve timestamp precision and proxy selection for video screenshots ([#374](https://github.com/shumaiOne/shumai/pull/374))
- **agent**: Support dynamic annotationId resolution across chat and comments ([#375](https://github.com/shumaiOne/shumai/pull/375))
- **agent**: Consolidate media tools into read_asset and add S3 key support to download_asset ([#376](https://github.com/shumaiOne/shumai/pull/376))
- **provider**: Optimize provider and model configuration management ([#377](https://github.com/shumaiOne/shumai/pull/377))
- **provider**: Add provider and model sync feature with vendored generator ([#378](https://github.com/shumaiOne/shumai/pull/378))
### Fixed
- **agent**: Set empty details in asset tool results to avoid data duplication ([#370](https://github.com/shumaiOne/shumai/pull/370))
- **webui**: Strip styles and preserve multiline text on paste in chat input ([#371](https://github.com/shumaiOne/shumai/pull/371))
- **agent**: Hide main comment sessions in dashboard sessions list ([#372](https://github.com/shumaiOne/shumai/pull/372))
### Changed
- **webui**: Use semantic system colors in notification settings ([#379](https://github.com/shumaiOne/shumai/pull/379))
## [0.4.1] - 2026-08-30
### Added
- **webui**: Add manage versions option to file card context menu ([#364](https://github.com/shumaiOne/shumai/pull/364))
- **agent**: Refactor message context into unified shumai_message ([#365](https://github.com/shumaiOne/shumai/pull/365))
- **webui**: Redesign comment attachment display into compact rows ([#366](https://github.com/shumaiOne/shumai/pull/366))
### Fixed
- **asset,webui**: Disallow dropping version stacks onto files and version stacks ([#363](https://github.com/shumaiOne/shumai/pull/363))
- **webui**: Prevent empty folder flash during initial loading ([#367](https://github.com/shumaiOne/shumai/pull/367))
### Changed
- **agent**: Remove executeAgentToolWorkflow and invoke core services directly ([#362](https://github.com/shumaiOne/shumai/pull/362))
## [0.4.0] - 2026-08-28
### Added
- **transcode**: Add hardware-accelerated video transcoding support ([#352](https://github.com/shumaiOne/shumai/pull/352))
- **webui**: Truncate long file names with 100ms hover tooltip ([#355](https://github.com/shumaiOne/shumai/pull/355))
- **webui**: Add simplified mobile-friendly layout for file and share lists ([#356](https://github.com/shumaiOne/shumai/pull/356))
- **webui**: Add mobile friendly file detail and public share view ([#359](https://github.com/shumaiOne/shumai/pull/359))
### Fixed
- **transcode**: Apply team hardware acceleration and source bitrate capping to watermark transcoding ([#353](https://github.com/shumaiOne/shumai/pull/353))
- **share**: Hide and soft-delete symlinks when target assets are trashed ([#354](https://github.com/shumaiOne/shumai/pull/354))
- **webui**: Fix breadcrumb file dropdown trigger stretching and alignment ([#360](https://github.com/shumaiOne/shumai/pull/360))
- **webui**: Align mobile comment cards and thread vertical indicator ([#361](https://github.com/shumaiOne/shumai/pull/361))
### Documentation
- Add SECURITY.md with a private disclosure path ([#357](https://github.com/shumaiOne/shumai/pull/357))
## [0.3.11] - 2026-08-25
### Added
- **auth**: Add admin password reset CLI command and reset password web UI ([#347](https://github.com/shumaiOne/shumai/pull/347))
- **project**: Add recent viewed files section to project folder tree ([#348](https://github.com/shumaiOne/shumai/pull/348))
### Fixed
- **webui**: Prevent left carousel remounting and scroll jump on file selection ([#351](https://github.com/shumaiOne/shumai/pull/351))
## [0.3.10] - 2026-08-23
### Added
- **agentic kanban**: Phase 1 not-agentic kanban board ([#330](https://github.com/shumaiOne/shumai/pull/330))
- **kanban**: Resolve latest version for linked version stack assets and update demo login text ([#342](https://github.com/shumaiOne/shumai/pull/342))
- **kanban**: Update task status permissions, reporter defaults, and participant access ([#345](https://github.com/shumaiOne/shumai/pull/345))
### Fixed
- **kanban**: Use true thumbnail and poster for task asset previews ([#343](https://github.com/shumaiOne/shumai/pull/343))
- **webui**: Sidebar selection styling, kanban active state, pointer cursors, and owner dashboard ([#344](https://github.com/shumaiOne/shumai/pull/344))
- **kanban**: Improve drag-drop to column bottom, remove empty drop line, and fix timeline alignment ([#346](https://github.com/shumaiOne/shumai/pull/346))
## [0.3.9] - 2026-08-18
### Added
- **agent**: Add permission controls for chat agents ([#313](https://github.com/shumaiOne/shumai/pull/313))
- **authz**: Enforce project-aware roles for agent/skill/mcp permissions ([#314](https://github.com/shumaiOne/shumai/pull/314))
- **webui**: Use project members for asset comment mentions ([#315](https://github.com/shumaiOne/shumai/pull/315))
- **quota**: Add 2-level database-backed resource quota system ([#318](https://github.com/shumaiOne/shumai/pull/318))
- **settings**: Reorganize settings into personal, team, and AI sections ([#324](https://github.com/shumaiOne/shumai/pull/324))
- **quota**: Move usage monitoring to team dashboard ([#327](https://github.com/shumaiOne/shumai/pull/327))
### Fixed
- **webui**: Preserve selected chatbot agent preference on reload ([#323](https://github.com/shumaiOne/shumai/pull/323))
- **quota**: Exclude agents from quota rules and usage records ([#325](https://github.com/shumaiOne/shumai/pull/325))
### Documentation
- **team-settings**: Add resource quotas documentation and update readme features ([#326](https://github.com/shumaiOne/shumai/pull/326))
## [0.3.8] - 2026-08-15
### Added
- **webui**: Replace legacy markdown editor with new lexical wysiwyg editor ([#308](https://github.com/shumaiOne/shumai/pull/308))
- **agent**: Add nested agents.md support across backend and webui ([#309](https://github.com/shumaiOne/shumai/pull/309))
- **webui**: Improve AGENTS.md editor placeholder and read-only notice ([#310](https://github.com/shumaiOne/shumai/pull/310))
- **version-stack**: Add manage versions dialog and version removal ([#311](https://github.com/shumaiOne/shumai/pull/311))
### Fixed
- **core**: Rename latest version child record on version stack rename ([#312](https://github.com/shumaiOne/shumai/pull/312))
## [0.3.7] - 2026-08-14
### Added
- **metadata**: Replace aiAutofill boolean with autofillSource enum ([#302](https://github.com/shumaiOne/shumai/pull/302))
- **agent**: Type-safe CREATION_CONTEXT metadata on create_file/create_version ([#303](https://github.com/shumaiOne/shumai/pull/303))
- **sandbox**: Default Network Sandbox to off and add settings toggle switch ([#304](https://github.com/shumaiOne/shumai/pull/304))
- **webui**: Redesign select metadata fields and improve long text field widget ([#305](https://github.com/shumaiOne/shumai/pull/305))
- **agent**: Support dynamic newOption in select and selectMulti metadata fields ([#306](https://github.com/shumaiOne/shumai/pull/306))
### Fixed
- **webui**: Fix select field height and multi-select overflow/interaction issues ([#307](https://github.com/shumaiOne/shumai/pull/307))
## [0.3.6] - 2026-08-12
### Added
- **mcp**: Add MCP server support with proxy tool and OAuth flow ([#289](https://github.com/shumaiOne/shumai/pull/289))
- **mcp**: Support tool-level directTools array and 3-state UI configuration ([#297](https://github.com/shumaiOne/shumai/pull/297))
- **webui**: Direct canvas PDF rendering with selectable text ([#299](https://github.com/shumaiOne/shumai/pull/299))
### Fixed
- **agent**: Prevent agents from accessing disabled skills ([#292](https://github.com/shumaiOne/shumai/pull/292))
- **agent**: Resolve version stack name and size in list_assets ([#296](https://github.com/shumaiOne/shumai/pull/296))
- **webui**: Content-only pinch-zoom and two-finger pan in media viewers ([#298](https://github.com/shumaiOne/shumai/pull/298))
- **i18n**: Update Chinese translation for dashboard to 仪表板 ([#301](https://github.com/shumaiOne/shumai/pull/301))
### Documentation
- **mcp**: Add MCP support documentation to README and docs ([#300](https://github.com/shumaiOne/shumai/pull/300))
## [0.3.5] - 2026-08-09
### Added
- **transcode**: Add Gotenberg support for Office, HTML, CSV, and Markdown PDF proxies ([#283](https://github.com/shumaiOne/shumai/pull/283))
### Fixed
- **webui**: Resolve upload card freeze for unsupported files ([#284](https://github.com/shumaiOne/shumai/pull/284))
- **webui**: Exclude file extension when selecting file name during inline rename ([#285](https://github.com/shumaiOne/shumai/pull/285))
- Use renamed asset name in download Content-Disposition ([#286](https://github.com/shumaiOne/shumai/pull/286))
- **webui**: Batch download no longer flashes a tab per file ([#287](https://github.com/shumaiOne/shumai/pull/287))
- **webui**: Enable rename and delete actions in file detail top bar breadcrumb ([#288](https://github.com/shumaiOne/shumai/pull/288))
## [0.3.4] - 2026-08-08
### Added
- **sharelink**: Add sharelink watermark support ([#270](https://github.com/shumaiOne/shumai/pull/270))
- **webui**: Remove original-file display fallbacks, use proxies only ([#273](https://github.com/shumaiOne/shumai/pull/273))
- **share**: Add allow download config to share links ([#275](https://github.com/shumaiOne/shumai/pull/275))
- **transcode**: Update preview thumbnail resolution to 300p with max length constraint ([#281](https://github.com/shumaiOne/shumai/pull/281))
### Fixed
- **share**: Resolve symlink asset downloads in public share pages ([#274](https://github.com/shumaiOne/shumai/pull/274))
- **webui**: Persist project sorting and prevent full page flash ([#276](https://github.com/shumaiOne/shumai/pull/276))
### Documentation
- **share-links**: Document allow download and lazy watermark settings ([#278](https://github.com/shumaiOne/shumai/pull/278))
- **agent**: Clarify create_file/create_version context param guidance ([#282](https://github.com/shumaiOne/shumai/pull/282))
### Maintenance
- **e2e**: Watermarked download-disabled share link coverage (image + video) ([#277](https://github.com/shumaiOne/shumai/pull/277))
- **e2e**: Stabilize watermark share spec on Firefox ([#279](https://github.com/shumaiOne/shumai/pull/279))
- Split e2e scripts into app and webui targets ([#280](https://github.com/shumaiOne/shumai/pull/280))
## [0.3.3] - 2026-08-05
### Added
- **agent**: Enable LLM API call retries in AgentHarness ([#250](https://github.com/shumaiOne/shumai/pull/250))
- **audit**: Add audit log support for APIs and WebUI dashboard ([#251](https://github.com/shumaiOne/shumai/pull/251))
- **webui**: Persist agent preference in localStorage ([#254](https://github.com/shumaiOne/shumai/pull/254))
- **e2e**: Add file domain comment and draw tests ([#260](https://github.com/shumaiOne/shumai/pull/260))
- **agent**: Restrict bash access for non-owner users ([#262](https://github.com/shumaiOne/shumai/pull/262))
- **agent**: Allow create_file tool to create files directly from content ([#263](https://github.com/shumaiOne/shumai/pull/263))
- **agent**: Propagate autofill context from chat to autofill workflow ([#264](https://github.com/shumaiOne/shumai/pull/264))
- **webui**: Render select options in field creation mode and pick random option color ([#265](https://github.com/shumaiOne/shumai/pull/265))
- **project**: Include team-scoped members in project member list and add 3-section dialog layout ([#267](https://github.com/shumaiOne/shumai/pull/267))
- **webui**: Disable role dropdown for project-scoped members in team view ([#269](https://github.com/shumaiOne/shumai/pull/269))
### Fixed
- **webui**: Mention popup avatars, keyboard auto-scroll, and non-sticky section headers ([#256](https://github.com/shumaiOne/shumai/pull/256))
- **webui**: Persist field order on drag and drop ([#266](https://github.com/shumaiOne/shumai/pull/266))
### Changed
- **agent**: Load models directly from database without pi fallback ([#253](https://github.com/shumaiOne/shumai/pull/253))
- **core**: Replace generated provider files with pi-ai dynamic methods ([#255](https://github.com/shumaiOne/shumai/pull/255))
### Maintenance
- **core**: Add missing tests for methods introduced in 97069042 ([#252](https://github.com/shumaiOne/shumai/pull/252))
- **e2e**: Add domain-based auth and project web app e2e tests ([#257](https://github.com/shumaiOne/shumai/pull/257))
- **e2e**: Add file, share, and collection web app e2e tests ([#258](https://github.com/shumaiOne/shumai/pull/258))
- **e2e**: Add project-level invite and file-move e2e tests ([#259](https://github.com/shumaiOne/shumai/pull/259))
- **e2e**: Add search in file list and save-search-as-collection cases ([#261](https://github.com/shumaiOne/shumai/pull/261))
- **e2e**: Add member permission change tests ([#268](https://github.com/shumaiOne/shumai/pull/268))
## [0.3.2] - 2026-07-30
### Added
- **agent**: Add output truncation and streaming limits to sandboxed bash tool ([#248](https://github.com/shumaiOne/shumai/pull/248))
### Fixed
- **agent**: Download original document asset instead of pdf proxy ([#247](https://github.com/shumaiOne/shumai/pull/247))
- **webui**: Persist chatbot sidebar input text across route navigation ([#249](https://github.com/shumaiOne/shumai/pull/249))
## [0.3.1] - 2026-07-30
### Added
- **transcode**: Trigger ai metadata autofill post transcode ([#234](https://github.com/shumaiOne/shumai/pull/234))
- **dashboard**: Add agent sessions view for team owners ([#237](https://github.com/shumaiOne/shumai/pull/237))
- **db**: Preserve agent sessions on asset deletion by setting onDelete to SetNull ([#240](https://github.com/shumaiOne/shumai/pull/240))
- **agent**: Add download_asset tool and prompt instructions ([#242](https://github.com/shumaiOne/shumai/pull/242))
- **db**: Update Asset.sizeByte and AiUsage token fields to BigInt ([#244](https://github.com/shumaiOne/shumai/pull/244))
### Fixed
- **agent**: Include select option labels and field name in autofill schema ([#235](https://github.com/shumaiOne/shumai/pull/235))
- **agent**: Scope agent comment sessions to thread sessions anchored at root comments ([#239](https://github.com/shumaiOne/shumai/pull/239))
- **agent**: Disable tools for session naming and make naming non-blocking ([#241](https://github.com/shumaiOne/shumai/pull/241))
- **webui**: Update file size formatting to SI decimal standard ([#245](https://github.com/shumaiOne/shumai/pull/245))
- **s3**: Enforce property syntax in S3Service interface and fix ReadableStream handling in S3StorageService ([#246](https://github.com/shumaiOne/shumai/pull/246))
## [0.3.0] - 2026-07-28
### Added
- **file-browser**: Add copy name and path option to context menu ([#225](https://github.com/shumaiOne/shumai/pull/225))
- **agent**: Inject user name and role into chat context ([#226](https://github.com/shumaiOne/shumai/pull/226))
- **agent**: Refactor database session storage to normalized DAG entries and lazy thread sync ([#229](https://github.com/shumaiOne/shumai/pull/229))
- **agent**: Support ENABLE_WEAKER_NESTED_SANDBOX environment variable ([#233](https://github.com/shumaiOne/shumai/pull/233))
### Fixed
- **agent**: Ensure atomic appendEntry and persist leaf entries in DatabaseSessionStorage ([#224](https://github.com/shumaiOne/shumai/pull/224))
- Sharp version mismatch bug ([#230](https://github.com/shumaiOne/shumai/pull/230))
- **agent**: Resolve S3 MIME type detection and prompt parameter in image analysis ([#232](https://github.com/shumaiOne/shumai/pull/232))
### Changed
- **agent**: Remove implicit agent mention trigger in comment threads ([#227](https://github.com/shumaiOne/shumai/pull/227))
### Maintenance
- **workflow**: Add docker compose deployment verification job ([#231](https://github.com/shumaiOne/shumai/pull/231))
## [0.2.3] - 2026-07-25
### Fixed
- **webui**: Show right sidebar by default on file detail page ([#219](https://github.com/shumaiOne/shumai/pull/219))
- **webui**: Refresh file list and detail when agent executes asset creation tools ([#220](https://github.com/shumaiOne/shumai/pull/220))
- **webui**: Fix space key drag overlay and shift range selection for version stacks ([#221](https://github.com/shumaiOne/shumai/pull/221))
- **transcode**: Handle timestamp rounding tolerance for screenshot annotations ([#223](https://github.com/shumaiOne/shumai/pull/223))
### Changed
- **e2e**: Split transcode workflow E2E tests into per-workflow test files ([#222](https://github.com/shumaiOne/shumai/pull/222))
## [0.2.2] - 2026-07-23
### Added
- **webui**: Integrate AI usage API into dashboard page ([#216](https://github.com/shumaiOne/shumai/pull/216))
- **ai-usage**: Add team and member token usage tracking and APIs ([#215](https://github.com/shumaiOne/shumai/pull/215))
- **transcode**: Add PSD support via ImageMagick and enforce sRGB conversion ([#217](https://github.com/shumaiOne/shumai/pull/217))
### Fixed
- **search**: Fix buildSqlCondition date range, numeric metadata, and string parsing bugs ([#213](https://github.com/shumaiOne/shumai/pull/213))
- **webui**: Prevent horizontal overflow in search dialog result rows ([#214](https://github.com/shumaiOne/shumai/pull/214))
- **webui**: Invalidate upload tasks query when upload task starts and completes ([#218](https://github.com/shumaiOne/shumai/pull/218))
## [0.2.1] - 2026-07-22
### Added
- **skill**: Add team owner skill permission control ([#209](https://github.com/shumaiOne/shumai/pull/209))
### Fixed
- **agent**: Handle non-builtin models in getModelFromDb and upgrade pi-ai ([#211](https://github.com/shumaiOne/shumai/pull/211))
- **provider**: Preserve model ids on provider update ([#212](https://github.com/shumaiOne/shumai/pull/212))
### Changed
- **core**: Split generated providers into per-provider files ([#210](https://github.com/shumaiOne/shumai/pull/210))
## [0.2.0] - 2026-07-21
### Added
- **transcode**: Add PDF preview, sprite generation, and annotation support ([#193](https://github.com/shumaiOne/shumai/pull/193))
- **web**: Register pdf.worker route in production ([#195](https://github.com/shumaiOne/shumai/pull/195))
- **agent**: Add read_pdf_pages tool and PDF page context support ([#196](https://github.com/shumaiOne/shumai/pull/196))
- **transcode**: Split monolithic transcodeMedia into focused workflows ([#197](https://github.com/shumaiOne/shumai/pull/197))
- **transcode**: Add PDF proxy support for TXT and CSV files ([#199](https://github.com/shumaiOne/shumai/pull/199))
- **asset**: Replace mediaType/mimeType logic with proxyType ([#200](https://github.com/shumaiOne/shumai/pull/200))
- **docker**: Install fonts-noto-cjk in runner stage ([#202](https://github.com/shumaiOne/shumai/pull/202))
- **transcode**: Add markdown file to pdf proxy support ([#203](https://github.com/shumaiOne/shumai/pull/203))
- **chat**: Track context asset changes and update agent context ([#204](https://github.com/shumaiOne/shumai/pull/204))
- **agent**: Refactor media tools to static injection with mandatory assetId and authz ([#208](https://github.com/shumaiOne/shumai/pull/208))
### Fixed
- **transcode**: Mark pdfkit as external and extract for docker runtime ([#201](https://github.com/shumaiOne/shumai/pull/201))
- **agent**: Include skill id in formatSkillsForPrompt ([#205](https://github.com/shumaiOne/shumai/pull/205))
- **asset**: Exclude soft-deleted children from latestChildren preview ([#206](https://github.com/shumaiOne/shumai/pull/206))
- **agent**: Pass latest version asset from version stack to prompt builder ([#207](https://github.com/shumaiOne/shumai/pull/207))
## [0.1.10] - 2026-07-16
### Added
- **workflow-e2e**: Add E2E tests for agentAutofillMedia workflow ([#188](https://github.com/shumaiOne/shumai/pull/188))
- **comments**: Support comment deletion and video player shortcuts ([#191](https://github.com/shumaiOne/shumai/pull/191))
- **agent**: Support disabling specific tools for agents ([#192](https://github.com/shumaiOne/shumai/pull/192))
### Maintenance
- **e2e**: Add E2E workflow tests for remaining agent and transcode services ([#189](https://github.com/shumaiOne/shumai/pull/189))
## [0.1.9] - 2026-07-14
### Added
- **e2e**: Set up fullstack app-level e2e test framework and signup test case ([#184](https://github.com/shumaiOne/shumai/pull/184))
- **chat**: Chatbot UI ([#185](https://github.com/shumaiOne/shumai/pull/185))
- **agent**: Support aborting agent execution ([#186](https://github.com/shumaiOne/shumai/pull/186))
### Changed
- **api/chat**: Remove direct Prisma query from API layer ([#187](https://github.com/shumaiOne/shumai/pull/187))
## [0.1.8] - 2026-07-10
### Added
- **chatbot**: Implement type-safe Chat APIs with compaction support ([#180](https://github.com/shumaiOne/shumai/pull/180))
### Fixed
- **webui**: Enable build splitting and code-split all page routes ([#183](https://github.com/shumaiOne/shumai/pull/183))
### Documentation
- **readme**: Clarify displayed file size represents original file size ([#182](https://github.com/shumaiOne/shumai/pull/182))
## [0.1.7] - 2026-07-06
### Added
- **audio**: Support frame-accurate audio playback, comments, and AI safeguards ([#175](https://github.com/shumaiOne/shumai/pull/175))
- **i18n**: Localize members dialog, notifications, uploads, user menus, dates, and players ([#178](https://github.com/shumaiOne/shumai/pull/178))
- **comments**: Allow marking comments as complete or incomplete ([#179](https://github.com/shumaiOne/shumai/pull/179))
### Fixed
- **upload**: Resolve empty and generic MIME types in confirmFileUpload ([#176](https://github.com/shumaiOne/shumai/pull/176))
### Changed
- **webui**: Modularize file viewer components into registry-driven architecture ([#174](https://github.com/shumaiOne/shumai/pull/174))
### Documentation
- Improve documentation and examples for S3 compatible storage ([#177](https://github.com/shumaiOne/shumai/pull/177))
## [0.1.6] - 2026-07-04
### Added
- **file-browser**: Show video duration on file card preview ([#170](https://github.com/shumaiOne/shumai/pull/170))
- **webui**: Compare versions view for version stacks ([#171](https://github.com/shumaiOne/shumai/pull/171))
### Fixed
- **webui**: Resolve conditional hooks and setState-in-render errors ([#167](https://github.com/shumaiOne/shumai/pull/167))
- **webui**: Resolve video player total frames mismatch ([#172](https://github.com/shumaiOne/shumai/pull/172))
- **version-stack**: Resolve correct latest version ID of version stack ([#173](https://github.com/shumaiOne/shumai/pull/173))
### Maintenance
- **webui**: Video player e2e framework + Safari playhead fix ([#166](https://github.com/shumaiOne/shumai/pull/166))
- **webui**: Add frame-accurate comment seek roundtrip e2e ([#168](https://github.com/shumaiOne/shumai/pull/168))
- **webui**: Verify video player restarts playback after end ([#169](https://github.com/shumaiOne/shumai/pull/169))
## [0.1.5] - 2026-07-02
### Changed
- **storage**: Use original filenames for stored files ([#165](https://github.com/shumaiOne/shumai/pull/165))
### Maintenance
- **release**: Add Aliyun ACR push to release workflow ([#164](https://github.com/shumaiOne/shumai/pull/164))
## [0.1.4] - 2026-07-01
### Added
- **transcode**: Change video poster resolution to 480p ([#161](https://github.com/shumaiOne/shumai/pull/161))
- **auth**: Allow setting user locale on signup ([#163](https://github.com/shumaiOne/shumai/pull/163))
### Fixed
- **webui**: Preserve video ended state by skipping playhead snap on ended ([#162](https://github.com/shumaiOne/shumai/pull/162))
## [0.1.3] - 2026-06-30
### Added
- **webui**: Add i18n support using paraglide-js ([#156](https://github.com/shumaiOne/shumai/pull/156))
- **video**: Add frame-accurate video player, SMPTE timecodes, and format switcher ([#157](https://github.com/shumaiOne/shumai/pull/157))
### Fixed
- **webui**: Align video timeline duration and formatting with frameio ([#158](https://github.com/shumaiOne/shumai/pull/158))
- **webui**: Fix missing left sidebar for nested folders ([#159](https://github.com/shumaiOne/shumai/pull/159))
- **api**: Fix update team settings and make request schema type-safe ([#160](https://github.com/shumaiOne/shumai/pull/160))
## [0.1.2] - 2026-06-25
### Changed
- **s3**: Remove automatic port appending to AWS_ENDPOINT_URL_S3 ([#155](https://github.com/shumaiOne/shumai/pull/155))
## [0.1.1] - 2026-06-23
### Added
- **docker**: Add root entrypoint with privilege dropping for data volumes ([#151](https://github.com/shumaiOne/shumai/pull/151))
## [0.1.0] - 2026-06-22
### Added
- **share**: Secure share info API and fix wrong password feedback ([#150](https://github.com/shumaiOne/shumai/pull/150))
### Fixed
- **webui**: Truncate long folder, collection, and share link names in sidebar ([#149](https://github.com/shumaiOne/shumai/pull/149))
## [0.0.11] - 2026-06-22
### Added
- **cli**: Add shumai-cli and token authentication ([#144](https://github.com/shumaiOne/shumai/pull/144))
- **settings**: Use singular headers and remove collapse/counters for single agent types ([#145](https://github.com/shumaiOne/shumai/pull/145))
- **folders**: Auto expand folder tree in left sidebar on navigation ([#146](https://github.com/shumaiOne/shumai/pull/146))
- **metadata**: Add single user and multiple user custom fields ([#147](https://github.com/shumaiOne/shumai/pull/147))
### Maintenance
- **cli**: Rename npm package to @shumai-one/shumai-cli ([#148](https://github.com/shumaiOne/shumai/pull/148))
## [0.0.10] - 2026-06-21
### Changed
- **web**: Dynamically register production HTML bundle routes ([#142](https://github.com/shumaiOne/shumai/pull/142))
### Documentation
- **readme**: Polish structure, correct grammar, and add dependencies table ([#143](https://github.com/shumaiOne/shumai/pull/143))
## [0.0.9] - 2026-06-20
### Added
- **webui**: Show app version in avatar menu ([#139](https://github.com/shumaiOne/shumai/pull/139))
- **cli**: Add background daemonization and subcommands ([#141](https://github.com/shumaiOne/shumai/pull/141))
### Maintenance
- **release**: Add smoke tests to local release stage ([#140](https://github.com/shumaiOne/shumai/pull/140))
## [0.0.8] - 2026-06-19
### Added
- **api**: Implement read-only mode for reviewers ([#122](https://github.com/shumaiOne/shumai/pull/122))
- **server**: Allow customizing server port via SHUMAI_SERVER_PORT ([#124](https://github.com/shumaiOne/shumai/pull/124))
- **embedding**: Defer embedding workflow, use transcoded assets, and execute chunks in separate activities ([#125](https://github.com/shumaiOne/shumai/pull/125))
- **webui**: Add external drag-and-drop file and folder upload support ([#126](https://github.com/shumaiOne/shumai/pull/126))
- **agent**: Implement overlapping video chunks for semantic search ([#127](https://github.com/shumaiOne/shumai/pull/127))
- **webui**: Support jumping to video timestamp from search results ([#128](https://github.com/shumaiOne/shumai/pull/128))
- **auth**: Add demo mode support ([#131](https://github.com/shumaiOne/shumai/pull/131))
- **auth**: Refine demo mode support ([#132](https://github.com/shumaiOne/shumai/pull/132))
- **webui**: Default right sidebar to collapsed for new users ([#133](https://github.com/shumaiOne/shumai/pull/133))
- **webui**: Use Shadcn Switch in toggle field and Rating component in search filter panel ([#137](https://github.com/shumaiOne/shumai/pull/137))
- **upload**: Track byte-level progress with XMLHttpRequest ([#138](https://github.com/shumaiOne/shumai/pull/138))
### Fixed
- **transcode**: Handle high-precision FPS using rational fractions ([#123](https://github.com/shumaiOne/shumai/pull/123))
- **db**: Automatically update project updatedAt on asset modification ([#129](https://github.com/shumaiOne/shumai/pull/129))
- **webui**: Use system colors for fields and improve search filter select options ([#130](https://github.com/shumaiOne/shumai/pull/130))
- **search**: Fix hasAny and hasNone operators on metadata filter ([#134](https://github.com/shumaiOne/shumai/pull/134))
- **webui**: Resolve folder tree sync, search dialog reset, and sidebar actions issues ([#136](https://github.com/shumaiOne/shumai/pull/136))
### Changed
- **webui**: Fix search dialog layout height, scroll areas, and restrict filter toggle click ([#135](https://github.com/shumaiOne/shumai/pull/135))
## [0.0.7] - 2026-06-17
### Added
- **workflow**: Configure transcode and agent concurrency via environment variables ([#116](https://github.com/shumaiOne/shumai/pull/116))
- **webui**: Replace hardcoded colors with system tokens ([#119](https://github.com/shumaiOne/shumai/pull/119))
- **webui**: Replace native overflow with shadcn ScrollArea in settings ([#120](https://github.com/shumaiOne/shumai/pull/120))
- **api**: Use enum for API protocol in provider config ([#121](https://github.com/shumaiOne/shumai/pull/121))
### Fixed
- **webui**: Reload video player and reset state when switching assets ([#114](https://github.com/shumaiOne/shumai/pull/114))
### Changed
- **transcode**: Relocate TranscodeService to core and flatten API package ([#115](https://github.com/shumaiOne/shumai/pull/115))
### Documentation
- Improve and restructure shumai documentation ([#118](https://github.com/shumaiOne/shumai/pull/118))
## [0.0.6] - 2026-06-15
### Added
- **sandbox**: Add pending domains support for network sandbox ([#109](https://github.com/shumaiOne/shumai/pull/109))
- **webui**: Always show right sidebar and implement left vertical carousel ([#111](https://github.com/shumaiOne/shumai/pull/111))
### Fixed
- **build**: Propagate termination signals to active child process in wrappers ([#102](https://github.com/shumaiOne/shumai/pull/102))
- **transcode**: Make deterministic transcode activity failures non-retryable in Temporal ([#104](https://github.com/shumaiOne/shumai/pull/104))
- **player**: Implement seekbar dragging and match hover highlight color ([#108](https://github.com/shumaiOne/shumai/pull/108))
- **webui**: Avoid refetching all pages on file/folder reorder ([#112](https://github.com/shumaiOne/shumai/pull/112))
- **webui**: Force video-player mime type to video/mp4 ([#113](https://github.com/shumaiOne/shumai/pull/113))
### Changed
- **webui**: Use system color design tokens in video player components ([#106](https://github.com/shumaiOne/shumai/pull/106))
- **webui**: Use requestAnimationFrame for smooth video progress bar updates ([#107](https://github.com/shumaiOne/shumai/pull/107))
- **webui**: Fetch agents in mention input list dynamically ([#110](https://github.com/shumaiOne/shumai/pull/110))
### Documentation
- **readme**: Add comprehensive README.md ([#103](https://github.com/shumaiOne/shumai/pull/103))
- **readme**: Improve remote deployment and temporal execution instructions ([#105](https://github.com/shumaiOne/shumai/pull/105))
## [0.0.5] - 2026-06-13
### Added
- **npm**: Auto deploy database migrations on package start ([#101](https://github.com/shumaiOne/shumai/pull/101))
## [0.0.4] - 2026-06-12
### Fixed
- **cli/docker**: Resolve global CLI external dependencies and fix Docker 404 error ([#100](https://github.com/shumaiOne/shumai/pull/100))
## [0.0.3] - 2026-06-12
### Fixed
- **cli**: Resolve platform binary path resolution under nested node_modules ([#99](https://github.com/shumaiOne/shumai/pull/99))
## [0.0.2] - 2026-06-12
### Fixed
- **npm**: Add repository metadata to package.json for provenance verification ([#98](https://github.com/shumaiOne/shumai/pull/98))
### Maintenance
- Add release-npm.yaml workflow ([#97](https://github.com/shumaiOne/shumai/pull/97))
## [0.0.1] - 2026-06-12
### Added
- Initial release of Shumai
Symlink
+1
View File
@@ -0,0 +1 @@
AGENTS.md
+23 -2
View File
@@ -1,5 +1,6 @@
#syntax=docker/dockerfile:1.7-labs
# Stage 1: Builder
FROM oven/bun:1 AS builder
FROM oven/bun:1.4.2 AS builder
WORKDIR /app
@@ -7,6 +8,7 @@ WORKDIR /app
COPY package.json bun.lock ./
COPY --parents packages/*/package.json ./
COPY --parents apps/*/package.json ./
COPY patches/ ./patches/
# Install dependencies (including devDependencies for build tools)
RUN bun install --frozen-lockfile
@@ -16,6 +18,9 @@ RUN ls -la packages/transcode/node_modules
# Copy source code
COPY . .
# Compile i18n
RUN bun run i18n:compile
# Build API and Worker
RUN bun run build.ts
@@ -23,7 +28,7 @@ RUN bun run build.ts
RUN bun run scripts/extract-runtime-deps.ts
# Stage 2: Runner
FROM oven/bun:1 AS runner
FROM oven/bun:1.4.2 AS runner
# Install ffmpeg/ffprobe
COPY --from=mwader/static-ffmpeg:8.1 /ffmpeg /usr/local/bin/
@@ -47,6 +52,10 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
socat \
ca-certificates \
bubblewrap \
gosu \
poppler-utils \
imagemagick \
fonts-noto-cjk \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
@@ -69,5 +78,17 @@ COPY --chown=bun:bun --from=builder /app/prisma.config.ts.prod ./prisma.config.t
# Expose port (Bun Hono defaults to 3000)
EXPOSE 3000
# Switch back to root at the end so the container runs the entrypoint as root
USER root
COPY scripts/docker-entrypoint.sh /usr/local/bin/docker-entrypoint.sh
RUN chmod +x /usr/local/bin/docker-entrypoint.sh
# Expose "bun index.js" as "shumai" CLI command (and alias "shuami")
RUN printf '#!/bin/sh\nexec bun /app/index.js "$@"\n' > /usr/local/bin/shumai \
&& chmod +x /usr/local/bin/shumai \
&& ln -s /usr/local/bin/shumai /usr/local/bin/shuami
ENTRYPOINT ["docker-entrypoint.sh"]
# Default command: run migrations and start API server
CMD ["sh", "-c", "bun prisma migrate deploy && bun index.js"]
+249 -188
View File
@@ -5,59 +5,133 @@
<h1 align="center">Shumai</h1>
<p align="center">
<strong>An open-source platform for all your creative work.</strong>
<strong>The best open-source Frame.io alternative for all your creative work.</strong>
</p>
<p align="center">
<a target="_blank" href="https://shumai.one/">Website</a> | <a target="_blank" href="https://docs.shumai.one/introduction">Docs</a> | <a target="_blank" href="https://staging.shumai.one">Demo</a>
<a href="https://hub.docker.com/r/shumaione/shumai"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/shumaione/shumai" /></a>
<a href="https://github.com/shumaiOne/shumai/releases"><img alt="GitHub latest release" src="https://img.shields.io/github/v/release/shumaiOne/shumai" /></a>
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
<a target="_blank" href="https://deepwiki.com/shumaiOne/shumai"><img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg" /></a>
</p>
<p align="center">
<a target="_blank" href="https://shumai.one/">Website</a> | <a target="_blank" href="https://docs.shumai.one/getting-started/overview">Docs</a> | <a target="_blank" href="https://staging.shumai.one">Demo</a> | <a target="_blank" href="https://discord.gg/sUzhujK6DD">Discord</a> | <a target="_blank" href="README_CN.md">中文</a>
</p>
![Shumai App Screenshot](docs/screenshot.webp)
## Features
- **S3-Compatible & Local FS Storage**: Securely store and serve your creative assets using local filesystems or any S3-compatible cloud storage (AWS S3, Cloudflare R2, MinIO, etc.).
- **Comments with Draw Annotations & Timestamps**: Give precise feedback with frame-specific drawing tools and exact timestamps directly on video and image assets.
- **Easy Share Links & Collections**: Create secure external share links and curated media collections to collaborate with external clients and stakeholders.
- **Team & Project Member Management**: Manage granular workspace permissions using team-level and project-level role-based access control.
- **Scalable Transcode Workflows via Temporal**: Offload resource-heavy video transcoding to a reliable background worker pool orchestrated by Temporal.
- **Flexible Asset Metadata System**: Customize your workspace metadata with dynamic, user-defined fields tailored to your production pipeline.
Shumai is an open-source Frame.io alternative built for creative teams to collaborate and share media with ease:
#### Shumai Agent
* **S3-Compatible & Local Storage**: Store and serve creative assets securely using the local filesystem or any S3-compatible storage service, including AWS S3, Cloudflare R2, and MinIO.
* **Frame-by-Frame Annotations & Comments**: Leave precise feedback with frame-specific drawing tools and timestamped comments on both video and image assets.
* **Secure Sharing & Collections**: Create private share links and curated media collections for clients, stakeholders, and collaborators.
* **Granular Access Control**: Manage workspace permissions with team-level and project-level role-based access control.
* **Distributed Transcoding via Temporal**: Offload resource-intensive video transcoding to a background worker pool orchestrated by Temporal.
* **Custom Asset Metadata**: Define dynamic metadata fields tailored to your production pipeline.
* **Share Link Watermarking**: Protect shared media with customizable text and image watermarks, and save watermark as reusable templates.
* **Wide File Format Support**: Preview common creative file formats, including images (with PSD support), videos, audio, and documents, while allowing any file type to be uploaded and stored.
* **Office & Document PDF Proxying via Gotenberg**: Convert Word, PowerPoint, Excel, Markdown, HTML, and CSV documents to high-quality PDF proxies for in-browser previewing using [Gotenberg](https://docs.shumai.one/using-shumai/gotenberg).
* **NLE Export & Premiere Pro Plugin (Experimental)**: Export timestamped review comments to your favorite non-linear editor (Premiere Pro XML, DaVinci Resolve EDL, Final Cut Pro, Avid Media Composer) or use the experimental Premiere Pro UXP plugin to import media assets and auto-sync comments directly to sequence timeline markers. See [documentation](https://docs.shumai.one/using-shumai/nle-and-premiere).
- **Chat with Agent as a Collaborator**: Converse with a context-aware AI agent directly within your project workspace.
- **Extend Agent with Skills**: Easily register new tools and custom skills for the agent to run and automate workflows.
- **Secure Sandboxed Execution**: Execute agent scripts and tasks in a secure, isolated sandbox environment.
- **AI-Powered Metadata Autofill**: Automatically generate tags, descriptions, and custom metadata for new assets using Google Gemini.
- **Semantic Asset Search**: Find assets instantly based on their visual and textual content using vector embeddings.
But Shumai goes beyond being a Frame.io alternative. With modern models like GPT-Image-2 and Seedance 2.5, AI can already handle a surprising amount of creative work. That means you can create or update videos and images from a simple prompt without having to jump back into Photoshop, Premiere or Houdini. That is why Shumai includes a powerful agent system:
> **AI is optional.** You can use Shumai as a traditional Frame.io alternative and completely ignore the AI features if they aren't useful for your team.
* **Agent as a Team Member**: Mention a context-aware AI agent with `@mentions` directly in asset comments, just like a real teammate.
* **Agent as a One-to-One Assistant**: Chat privately with the agent and ask it to help with tasks.
* **Custom Skills & Tools**: Extend the agent by registering custom scripts, tools, and automation skills.
* **Model Context Protocol (MCP)**: Connect agents to external tools and APIs through remote MCP servers, with OAuth authentication and per-agent MCP access.
* **Isolated Sandbox Execution**: Run agent-submitted scripts safely in a sandboxed environment.
* **AI Metadata Autofill**: Automatically fill in custom metadata for new assets.
* **Semantic Search**: Find assets by visual or conceptual meaning using vector embeddings (Gemini Embedding 2).
* **Resource Quotas**: Set usage limits on AI tokens, costs, and tool execution per member, role, or team-wide, with real-time tracking.
Here is a short demo video showing what the Shumai agent can do:
https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
Shumai also brings project management into the creative workflow. A built-in Kanban board helps teams organize tasks, track progress, and collaborate in one place.
The ultimate goal is an **agentic Kanban**, where agents and team members can work together on tasks. This is still a **work in progress**: you can already create tasks for AI agents, but agents cannot act on those tasks yet.
<img width="2880" height="2160" alt="localhost_3000_teams_01M0HQR3EEBS0B46K4FK39X2C8_kanban(1080p-2) (1)" src="https://github.com/user-attachments/assets/cd0648d0-c69a-4398-958b-8d15a33378b0" />
> [!NOTE]
> **Media Processing & Storage:** When uploading media, Shumai always preserves and stores your original raw file. Note that the file size shown in the system represents the original file size and does not include the size of any transcoded files. For all media types (both images and videos), Shumai creates a 300p WebP poster image to serve as the preview in the file list view. Additionally:
> * **For Images:** Shumai generates a high-quality WebP proxy at the exact same resolution as your original file for optimized viewing.
> * **For Videos:** It generates at least one proxy video (depending on your transcoding settings), alongside a sprite image and a small preview video (capped at 1600 frames) to enable fast timeline scrubbing and lightning-quick previews.
---
## Installation
### Option 1: Docker Compose (Quick Start)
Below is a quickstart guide for running Shumai with local storage. For advanced configuration options (including S3-compatible storage and Temporal workflow orchestration), see our [Documentation](https://docs.shumai.one/getting-started/overview).
The easiest way to run Shumai is using Docker Compose. You do not need to clone the repository:
### Option 1: Docker Compose
1. Create a `docker-compose.yaml` file by copying the configuration from [GitHub](https://github.com/shumaiOne/shumai/blob/main/docker-compose/local/docker-compose.yaml) or download it directly:
Docker Compose is the fastest way to get Shumai running. You do not need to clone the repository or install packages manually. Ensure you have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed, then follow these steps:
1. Create and navigate to a new directory for your configuration and data volumes:
```bash
mkdir shumai && cd shumai
```
2. Download the `docker-compose.yaml` file:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose.yaml
```
2. Configure environment variables (if deploying remotely):
If you are deploying Shumai to a remote server (e.g., AWS ECS, EC2, VPS), you must edit `docker-compose.yaml`, set `AWS_ENDPOINT_URL_S3` to your server's public IP or domain name (e.g., `http://12.345.567.789`).
3. Start the services:
3. Configure environment variables (optional):
* `SHUMAI_SERVER_PORT` controls the port the Shumai server listens on. The default is `3000`.
* By default, Shumai uses the bundled local storage service in this Docker Compose setup. To use an external S3-compatible storage instead, configure the environment variables for your S3 provider. Here are examples for AWS S3 and Cloudflare R2:
**AWS S3 Example:**
```yaml
STORAGE_BACKEND: s3
S3_BUCKET: your-bucket-name
S3_ACCESS_KEY_ID: your-access-key-id
S3_SECRET_ACCESS_KEY: your-secret-access-key
AWS_ENDPOINT_URL_S3: https://s3.us-east-1.amazonaws.com
```
**Cloudflare R2 Example:**
```yaml
STORAGE_BACKEND: s3
S3_BUCKET: your-bucket-name
S3_REGION: auto
S3_ACCESS_KEY_ID: your-access-key-id
S3_SECRET_ACCESS_KEY: your-secret-access-key
AWS_ENDPOINT_URL_S3: https://<account-id>.r2.cloudflarestorage.com
```
* By default, `AWS_ENDPOINT_URL_S3` is set to: `http://localhost:{SHUMAI_SERVER_PORT}`, if you use local storage and expose Shumai on a custom host/port combination, set `AWS_ENDPOINT_URL_S3` to the external URL that browsers will use to upload files.
For example, if you change the port mapping in `docker-compose.yaml` from `3000:3000` to `12345:3000` and deploy on a server with IP address `12.34.56.78`, set:
```
AWS_ENDPOINT_URL_S3: http://12.34.56.78:12345
```
This value must be reachable from client browsers and should include the externally exposed port.
5. Start the services in detached mode:
```bash
docker compose up -d
```
4. Access the application in your browser at `http://localhost:3000` (or `http://<your-server-ip>:3000` for remote deployments).
6. Open your browser and access Shumai at `http://localhost:3000` (or `http://<your-server-ip>:3000` for remote deployments).
### Option 2: Install from NPM
### Option 2: Install via NPM / Package Manager
You can run Shumai using the npm package `@shumai-one/shumai`. This option allows you to install and run Shumai globally or locally via your favorite package manager.
Shumai is published as `@shumai-one/shumai` on NPM. This option allows you to run Shumai globally or locally.
#### Step 1: Start PostgreSQL with pgvector
Shumai requires PostgreSQL with the `pgvector` extension. You can spin up a pre-configured database container using Docker:
Shumai requires PostgreSQL with the `pgvector` extension. Start a pre-configured database container using Docker:
```bash
docker run --name shumai_postgres \
@@ -68,62 +142,173 @@ docker run --name shumai_postgres \
-d pgvector/pgvector:pg18
```
#### Step 2: Install Shumai globally
#### Step 2: Create a workspace folder
Install the main Shumai package using `npm`, `pnpm`, `bun`, or `yarn`:
Create a dedicated directory to store your environment configuration and media files (which are saved in a `./data` directory by default):
> [!IMPORTANT]
> **Prerequisites**:
```bash
mkdir shumai && cd shumai
```
#### Step 3: Install Platform-Specific Dependencies
#### Linux
Shumai requires the following system packages on Linux:
- **`ffmpeg`** – Used for media transcoding and metadata extraction.
- **`poppler`** (`poppler-utils`) – Used for PDF page image extraction and PDF sprite preview generation (`pdftoppm`).
- **`imagemagick`** – Used for PSD format transcoding and color profile conversion to sRGB.
- **`bubblewrap`**, **`socat`**, and **`ripgrep`** – Required by the AI agent sandbox (`anthropic-experimental/sandbox-runtime`) for process isolation, networking, and workspace search.
Install all required packages with one command:
> Ubuntu/Debian
```bash
sudo apt install -y ffmpeg poppler-utils imagemagick bubblewrap socat ripgrep
```
> Fedora
```bash
sudo dnf install -y ffmpeg poppler-utils ImageMagick bubblewrap socat ripgrep
```
> Arch Linux
```bash
sudo pacman -S --noconfirm ffmpeg poppler imagemagick bubblewrap socat ripgrep
```
> [!NOTE]
> **Ubuntu 24.04+** restricts unprivileged user namespaces by default. This prevents `anthropic-experimental/sandbox-runtime` from using `bubblewrap` for sandbox isolation.
>
> - **Agent Sandbox**: Because Shumai uses a secure sandboxed execution environment for its AI agents, your machine must meet the platform requirements for the sandbox. Please verify you have installed the required dependencies for your OS as detailed in the [Agent Sandbox Platform Support](#agent-sandbox-platform-support) section.
> - **FFmpeg & FFprobe**: Shumai requires `ffmpeg` and `ffprobe` to be installed on your system path for handling media transcoding and metadata extraction.
> - macOS: `brew install ffmpeg`
> - Ubuntu/Debian: `sudo apt-get install ffmpeg`
> - Fedora: `sudo dnf install ffmpeg`
> To temporarily allow user namespaces:
>
> ```bash
> sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
> ```
>
> Alternatively, configure an AppArmor profile that grants the required `userns` permission to the relevant binaries.
---
#### macOS
Shumai requires:
- **`ffmpeg`** – Used for media transcoding and metadata extraction.
- **`poppler`** – Used for PDF page image extraction and PDF sprite preview generation (`pdftoppm`).
- **`imagemagick`** – Used for PSD format transcoding and color profile conversion to sRGB.
- **`ripgrep`** – Required by the AI agent sandbox (`anthropic-experimental/sandbox-runtime`).
Install the required packages with Homebrew:
```bash
brew install ffmpeg poppler imagemagick ripgrep
```
---
#### Windows (alpha)
> [!WARNING]
> Windows support in anthropic-experimental/sandbox-runtime is **alpha and the design is in flux**.
>
> The current implementation provides:
> - Network egress filtering via the **Windows Filtering Platform (WFP)**.
> - File read/write denial via **ACL stamping**.
>
> However, it is **not a security boundary against a deliberately adversarial sandboxed process**.
>
> The sandbox implementation will be substantially revised in a future release, where sandboxed processes will run under a dedicated sandbox user account.
Shumai requires:
- **`ffmpeg`** – Used for media transcoding and metadata extraction.
- **`imagemagick`** – Used for PSD format transcoding and color profile conversion to sRGB.
Install required packages using your preferred package manager:
**winget**
```powershell
winget install Gyan.FFmpeg ImageMagick.ImageMagick
```
**Chocolatey**
```powershell
choco install ffmpeg imagemagick
```
#### Step 4: Install Shumai globally
Install Shumai globally using your preferred package manager:
```bash
# NPM
npm install -g @shumai-one/shumai
# or: pnpm add -g @shumai-one/shumai
# or: bun add -g @shumai-one/shumai
# PNPM
pnpm add -g @shumai-one/shumai
# Bun
bun add -g @shumai-one/shumai
```
#### Step 3: Configure Environment Variables
#### Step 5: Configure Environment Variables
Create a new directory for your Shumai configuration and navigate into it:
```bash
mkdir shumai
cd shumai
```
Create a `.env` file in this folder and add the following configuration (which aligns with the Docker database command in Step 1):
Create a `.env` file in your workspace folder (`shumai/`) and add the following configuration:
```env
DATABASE_URL=postgresql://shumai:shumai_password@localhost:5432/shumai_db?schema=public
BETTER_AUTH_SECRET=ySxs7DxzHDZBbeeHNPEwBuspYwipBqz5Gk5XdBjNhWw=
STORAGE_BACKEND=local
SHUMAI_SERVER_PORT=3000
AWS_ENDPOINT_URL_S3=http://localhost
AWS_ENDPOINT_URL_S3=http://localhost:3000
# Optional: base URL for MCP OAuth redirects (defaults to BETTER_AUTH_URL)
MCP_OAUTH_REDIRECT_BASE_URL=http://localhost:3000
```
> [!NOTE]
> If you are deploying on a remote server, make sure to change `AWS_ENDPOINT_URL_S3` from `http://localhost` to your server's public IP address or domain name. `SHUMAI_SERVER_PORT` defaults to `3000` if not set.
> `SHUMAI_SERVER_PORT` sets the port the server starts on, while `AWS_ENDPOINT_URL_S3` is used by the browser to build file upload URLs.
> If deploying on a remote server (e.g. `http://123.456.7.8`) with a mapped port (e.g. `12345:3000` in docker-compose), set `AWS_ENDPOINT_URL_S3` to `http://123.456.7.8:12345`.
> `MCP_OAUTH_REDIRECT_BASE_URL` is only needed when MCP servers use OAuth: the authorization redirect URI defaults to `{BETTER_AUTH_URL}/api/mcp/oauth/callback`; set it to an externally reachable URL if the app is served behind a proxy.
#### Step 4: Run Shumai
#### Step 6: Run Shumai
Start the application from your configuration folder:
> [!IMPORTANT]
> **For Bun Users:** Since the published package binaries contain a `#!/usr/bin/env node` shebang, running the global command directly (e.g., `shumai`) will execute under Node.js. If you installed with Bun and want to run under the Bun runtime, you must prefix all commands with `bun run --bun` (e.g., `bun run --bun shumai`, `bun run --bun shumai -d`, `bun run --bun shumai stop`).
Start the application from your workspace folder:
```bash
shumai
```
On startup, Shumai will automatically run the necessary database migrations and start the web server at `http://localhost:3000`.
Alternatively, you can run and manage Shumai in daemon mode:
- **Start in daemon mode**:
```bash
shumai -d
```
- **Stop Shumai**:
```bash
shumai stop
```
- **Restart Shumai**:
```bash
shumai restart
```
- **Show/tail logs**:
```bash
shumai logs
```
On startup, Shumai will automatically run database migrations and start the web server at `http://localhost:3000`.
---
### Option 3: Run from Source
### Option 3: Run from Source (Development)
To run Shumai locally for development:
To set up Shumai locally for development:
1. Clone the repository and install dependencies:
```bash
@@ -131,151 +316,27 @@ To run Shumai locally for development:
cd shumai
bun install
```
2. Start the `pgvector` database container (as described in Option 2, Step 1).
3. Create a `.env` file at the root of the workspace using the example configuration from Option 2, Step 3.
4. Run the database migrations:
2. Start the `pgvector` database container (as described in **Option 2, Step 1**).
3. Create a `.env` file at the root of the workspace using the configuration from **Option 2, Step 5**.
4. Generate i18n translation files:
```bash
bun run i18n:compile
```
> [!TIP]
> During frontend development, you can run `bun run i18n:watch` in a separate terminal to automatically recompile translation files whenever you edit strings in `packages/webui/messages/`.
5. Apply the database schema migrations:
```bash
bun run db:migrate
```
5. Start the development server:
6. Start the local development server:
```bash
bun run dev
```
---
## Advanced: Distributed Execution with Temporal
## Command Line Interface (CLI)
For production environments or workloads with heavy media processing and AI agent requirements, Shumai can delegate background activities to **Temporal**. This provides distributed queue management, task retries, and high availability.
Shumai provides a Command Line Interface (CLI) tool to manage projects, folders, and assets, upload files/folders, and create new versions directly from your terminal.
### How it works
By setting the environment variable `WORKFLOW_EXECUTOR=temporal`, the main Shumai application will delegate background workflows to a Temporal cluster instead of using the local polling-based engine. This allows you to run independent worker processes (`shumai-agent` and `shumai-transcode`) on separate specialized machines (e.g., transcoding workers on GPU-accelerated instances, and agents on sandboxed environments).
> [!IMPORTANT]
> **Storage Requirement**: Because the main Shumai application and the background workers run on different machines in a distributed setup, **you must use S3-compatible storage** (e.g., AWS S3, Cloudflare R2, MinIO). Local storage (`STORAGE_BACKEND=local`) will not work because the workers and the main application do not share a common local filesystem.
### 1. Set up the Core Stack
Spin up the database, Temporal server, and the main Shumai web application on your primary host machine using Docker Compose:
1. Download the Temporal-enabled `docker-compose.yaml` file:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/temporal/docker-compose.yaml
```
2. Configure the environment variables in `docker-compose.yaml`:
- Set the S3 storage environment variables (`AWS_ENDPOINT_URL_S3`, `S3_REGION`, `S3_BUCKET`, etc.).
- If deploying to a remote host (e.g., AWS ECS, EC2, VPS), update `AWS_ENDPOINT_URL_S3` under the `shumai` service to your server's public IP address or domain name.
- Note: The `TEMPORAL_ADDRESS` environment variable for the main Shumai application is pre-configured as `temporal:7233` (referencing the Temporal container within the same Docker network) and does not need to be changed.
3. Start the services:
```bash
docker compose up -d
```
This exposes the Shumai Web UI at `http://<host-ip>:3000`, the database at port `5432`, the Temporal gRPC service at port `7233`, and the Temporal dashboard at `http://<host-ip>:8080`. Ensure that port `7233` is exposed and accessible by your background worker machines.
### 2. Run the Background Workers
When running in Temporal mode, the main Shumai application only submits tasks to the Temporal queue. To process these tasks, you must run at least one agent worker and one transcoding worker on their respective machines.
> [!NOTE]
> **Network & Access Requirements**:
>
> - Both the transcode worker and the agent worker must have network access to the PostgreSQL database and the S3-compatible storage.
> - Because the transcode worker needs to download and upload large media files for transcoding, it is highly recommended to deploy the transcode worker in the same cloud provider and region as your S3 storage to minimize transfer latency and data egress fees.
Configure a `.env` file on each worker machine. It must contain the following variables:
```env
DATABASE_URL=postgresql://shumai:shumai_password@<host-ip>:5432/shumai_db?schema=public
WORKFLOW_EXECUTOR=temporal
TEMPORAL_ADDRESS=<host-ip>:7233
STORAGE_BACKEND=s3
AWS_ENDPOINT_URL_S3=http://<host-ip> # Or your public S3/R2 endpoint URL
S3_REGION=us-east-1
S3_BUCKET=shumai
S3_ACCESS_KEY_ID=your-access-key-id
S3_SECRET_ACCESS_KEY=your-secret-access-key
```
Run the workers:
- **Transcoding Worker**:
Install `@shumai-one/shumai-transcode` and run it on a machine with sufficient transcoding resources:
> [!IMPORTANT]
> **FFmpeg Requirement**: The transcoding worker requires `ffmpeg` and `ffprobe` to be installed and available on the machine's system path.
>
> - macOS: `brew install ffmpeg`
> - Ubuntu/Debian: `sudo apt-get install ffmpeg`
```bash
npm install -g @shumai-one/shumai-transcode
# Run worker with the configured .env
shumai-transcode
```
- **AI Agent Worker**:
Install `@shumai-one/shumai-agent` and run it on a machine configured for Agent tasks:
> [!IMPORTANT]
> Because the AI Agent worker runs sandboxed agent scripts, the host machine must have the necessary dependencies installed. Please refer to [Agent Sandbox Platform Support](#agent-sandbox-platform-support) for setup details.
```bash
npm install -g @shumai-one/shumai-agent
# Run worker with the configured .env (must include GEMINI_API_KEY)
shumai-agent
```
---
## Agent Sandbox Platform Support
Shumai uses `anthropic-experimental/sandbox-runtime` to execute AI agent scripts and tasks in a secure, isolated sandbox environment. When installing Shumai or the AI Agent worker from NPM, ensure your host platform meets the following requirements:
### Platform Support
- **macOS**: Uses `sandbox-exec` with custom profiles (no additional OS-level containerization dependencies).
- **Linux**: Uses `bubblewrap` (bwrap) for containerization.
- **Windows**: Not yet supported.
### Platform-Specific Dependencies
#### Linux
The following system packages must be installed on your Linux host:
- `bubblewrap` - Container runtime
- Ubuntu/Debian: `sudo apt-get install bubblewrap`
- Fedora: `sudo dnf install bubblewrap`
- Arch: `sudo pacman -S bubblewrap`
- `socat` - Socket relay for proxy bridging
- Ubuntu/Debian: `sudo apt-get install socat`
- Fedora: `sudo dnf install socat`
- Arch: `sudo pacman -S socat`
- `ripgrep` - Fast search tool for deny path detection
- Ubuntu/Debian: `sudo apt-get install ripgrep`
- Fedora: `sudo dnf install ripgrep`
- Arch: `sudo pacman -S ripgrep`
**Ubuntu 24.04+ Note**: These releases restrict unprivileged user namespaces by default. Disable this restriction so that `bubblewrap` and the seccomp isolation layer can function:
```bash
sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
```
**Optional Linux Dependencies (for seccomp fallback)**:
Pre-generated seccomp filters are provided for x86-64 and arm architectures. If you run on a different architecture, you will need a C compiler and development files:
- `gcc` or `clang`
- `libseccomp` development headers
- Ubuntu/Debian: `sudo apt-get install gcc libseccomp-dev`
- Fedora: `sudo dnf install gcc libseccomp-devel`
- Arch: `sudo pacman -S gcc libseccomp`
#### macOS
The following dependencies are required on macOS:
- `ripgrep` - Fast search tool for deny path detection
- Install via Homebrew: `brew install ripgrep`
- Or download from: https://github.com/BurntSushi/ripgrep/releases
For more details on installation and usage, see the [CLI Readme](apps/cli/README.md).
+386
View File
@@ -0,0 +1,386 @@
<p align="center">
<img src="docs/logo-rounded.png" alt="Shumai Logo" width="65" />
</p>
<h1 align="center">Shumai</h1>
<p align="center">
<strong>为创意工作打造的开源协作平台。</strong>
</p>
<p align="center">
<a href="https://hub.docker.com/r/shumaione/shumai"><img alt="Docker pulls" src="https://img.shields.io/docker/pulls/shumaione/shumai" /></a>
<a href="https://github.com/shumaiOne/shumai/releases"><img alt="GitHub latest release" src="https://img.shields.io/github/v/release/shumaiOne/shumai" /></a>
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
<a target="_blank" href="https://deepwiki.com/shumaiOne/shumai"><img alt="Ask DeepWiki" src="https://deepwiki.com/badge.svg" /></a>
</p>
<p align="center">
<a target="_blank" href="https://shumai.one/">官方网站</a> | <a target="_blank" href="https://docs.shumai.one/getting-started/overview">文档</a> | <a target="_blank" href="https://staging.shumai.one">在线演示</a> | <a target="_blank" href="README.md">English</a>
</p>
![Shumai 应用截图](docs/screenshot.webp)
## 功能
Shumai 是一个开源的 Frame.io 替代方案,专为创意团队打造,让大家能更轻松地协作、审片和分享素材:
* **支持 S3 和本地存储**:你可以把创意素材安全地存到本地文件系统,或者任意兼容 S3 的存储服务里,比如 AWS S3、Cloudflare R2、MinIO 等。
* **逐帧标注和评论**:支持按帧进行精确反馈,可以直接在视频和图片素材上画重点、写评论,还能留下时间戳。
* **安全分享和合集管理**:可以生成私密分享链接,也能整理成精选合集,方便给客户、同事和合作方查看。
* **细粒度权限控制**:支持按团队、项目设置角色权限,方便管理不同成员的访问范围。
* **基于 Temporal 的分布式转码**:把吃资源的视频转码任务交给后台 worker 池处理,由 Temporal 统一调度。
* **自定义素材元数据**:可以按你的制作流程,自由定义动态元数据字段。
* **分享链接水印**:通过可自定义的文字和图片水印保护共享媒体,并将水印配置保存为模板以便重复使用。
* **丰富的文件格式支持**:支持预览常见创意文件格式,包括图片(支持 PSD)、视频、音频和文档,同时可上传和存储任意类型的文件。
* **基于 Gotenberg 的文档 PDF 转码代理**:通过集成 [Gotenberg](https://docs.shumai.one/using-shumai/gotenberg) 支持将 Word、PowerPoint、Excel、Markdown、HTML 和 CSV 文档高质量转换为 PDF 代理文件进行在线预览。
* **非编剪辑导出与 Premiere 插件(实验性)**:支持将时间戳审阅评论导出至常用非编软件(Premiere Pro XML、DaVinci Resolve EDL、Final Cut Pro、Avid Media Composer),或使用实验性的 Premiere Pro 原生 UXP 插件导入媒体素材并将评论自动同步为时间轴标记。详见[相关文档](https://docs.shumai.one/using-shumai/nle-and-premiere)。
但 Shumai 不仅仅只满足于 Frame.io 的开源替代。随着 GPT-Image-2、Seedance 2.5 这类强大模型的问世,AI已经生成产品级的图片/视频。很多时候,你只要给一句提示词,就能直接生成或修改图片和视频,而不用再打开 Photoshop、Premiere 或者 Houdini。也正因为这样,Shumai 才把 AI Agent 做成了核心能力:
* **Agent 就像团队成员**:你可以在素材评论区里直接用 `@` 提到 AI Agent,像拉一个真实同事进来一起看稿一样。
* **Agent 也能当你的私聊助手**:你可以单独和它聊天,让它帮你查东西、做任务。
* **自定义技能和工具**:你可以给 Agent 接上自己的脚本、工具和自动化能力。
* **Model Context Protocol (MCP) 支持**:通过远程 MCP 服务端为 Agent 接入外部工具与 API,支持 OAuth 鉴权与按 Agent 独立分配访问权限。
* **沙箱隔离执行**:Agent 生成的脚本会在隔离环境里运行,更安全。
* **AI 自动补全元数据**:新素材上传后,系统可以自动帮你补一些元数据。
* **语义搜索**:支持按画面内容或语义找素材,底层用的是向量 embedding(Gemini Embedding 2)。
* **资源配额**:支持按成员、角色或全团队对 AI Token、成本和工具调用设置使用上限与实时用量监控。
下面是一个简短的 demo 视频,展示了 Shumai Agent 能做什么:
https://github.com/user-attachments/assets/1186067a-72c0-41b9-836f-987438f2332a
Shumai 也将项目管理融入了创意工作流程。 内置的看板可以帮助团队整理任务以及跟踪进度。
最终目标是打造一个 Agentic看板,让 Agent 和团队成员能够围绕同一个目标协同工作。目前这一功能仍在开发中: 你已经可以在看板中为 Agent 创建任务,但 Agent 目前还无法自动执行这些任务。
<img width="2880" height="2160" alt="localhost_3000_teams_01M0HQR3EEBS0B46K4FK39X2C8_kanban(1080p-2) (1)" src="https://github.com/user-attachments/assets/29ff1db1-2d65-4e3c-b467-754b777b406f" />
> [!NOTE]
> **媒体处理与存储机制:** 上传媒体文件后,Shumai 始终会保留并存储原始文件。请注意,系统中显示的文件大小为原始文件的大小,不包含转码后生成的代理文件大小。无论图片还是视频,都会额外生成一张 300p 的 WebP 封面图,作为文件列表中的预览图。此外:
>
> * **图片:** 会生成一份与原图分辨率完全一致的高质量 WebP 转码版本,在保证画质的同时提升浏览性能。
> * **视频:** 会根据转码配置生成至少一个代理视频,同时生成雪碧图(Sprite)和一段最长 1600 帧的低分辨率转码视频,用于实现快速拖动时间轴和即时视频预览。
---
## 安装指南
以下是使用本地存储运行 Shumai 的快速上手指南。如需了解高级配置(包括 S3 兼容存储配置、Temporal 工作流编排等),请参阅我们的[官方文档](https://docs.shumai.one/getting-started/overview)。
### 方案一:使用 Docker Compose(推荐)
<details>
<summary>复制这个提示词,让agent帮你安装</summary>
```
请帮我在本机使用 Docker Compose 一键部署 Shumai。
请严格参考官方文档:
https://gh-proxy.com/https://raw.githubusercontent.com/shumaiOne/shumai/main/README_CN.md
要求:
1. 只能使用 Docker Compose local方式部署,不要使用其他部署方式。
2. 部署前请先检查本机是否已安装并可正常使用 Docker 和 Docker Compose。
3. 如果本机未安装 Docker,请立即提醒用户先安装 Docker,并停止后续部署操作。不要自行安装 Docker,也不要采用其他方式部署。
4. 获取 `docker-compose-aliyun.yaml` 文件内容时,必须通过 `https://gh-proxy.com` 加速访问,不要直接访问 GitHub Raw 地址。
```
</details>
使用 Docker Compose 是运行 Shumai 最快的方式。您无需克隆仓库,也不需要手动安装依赖包。请确保电脑上已安装 [Docker](https://docs.docker.com/get-docker/) 和 [Docker Compose](https://docs.docker.com/compose/install/),然后按照以下步骤操作:
1. 创建并进入一个新目录,用于存放配置文件和数据卷:
```bash
mkdir shumai && cd shumai
```
2. 下载 `docker-compose.yaml` 配置文件:
```bash
curl -o docker-compose.yaml https://raw.githubusercontent.com/shumaiOne/shumai/main/docker-compose/local/docker-compose-aliyun.yaml
```
3. 配置环境变量(可选):
* `SHUMAI_SERVER_PORT` 用于控制 Shumai 服务监听的端口,默认值为 `3000`。
* 默认情况下,该 Docker Compose 部署会自动启用集成的本地存储。若想切换至外部 S3 兼容存储,请在 `environment` 中配置 S3 提供商的环境变量。以下是 AWS S3 和 Cloudflare R2 的配置示例:
**AWS S3 示例:**
```yaml
STORAGE_BACKEND: s3
S3_BUCKET: your-bucket-name
S3_ACCESS_KEY_ID: your-access-key-id
S3_SECRET_ACCESS_KEY: your-secret-access-key
AWS_ENDPOINT_URL_S3: https://s3.us-east-1.amazonaws.com
```
**Cloudflare R2 示例:**
```yaml
STORAGE_BACKEND: s3
S3_BUCKET: your-bucket-name
S3_REGION: auto
S3_ACCESS_KEY_ID: your-access-key-id
S3_SECRET_ACCESS_KEY: your-secret-access-key
AWS_ENDPOINT_URL_S3: https://<account-id>.r2.cloudflarestorage.com
```
* 默认情况下 `AWS_ENDPOINT_URL_S3` 指向 `http://localhost:{SHUMAI_SERVER_PORT}`。如果您使用本地存储,但希望在自定义的主机名或端口上公开访问 Shumai,请务必将 `AWS_ENDPOINT_URL_S3` 修改为浏览器访问该服务时所使用的外部 URL。
例如,如果您将 `docker-compose.yaml` 中的端口映射从 `3000:3000` 修改为了 `12345:3000`,且服务部署在 IP 为 `12.34.56.78` 的服务器上,请进行如下设置:
```
AWS_ENDPOINT_URL_S3: http://12.34.56.78:12345
```
此地址必须能够从客户端浏览器正常访问,且必须包含对外暴露的实际端口号。
4. 在后台启动所有服务:
```bash
docker compose up -d
```
5. 打开浏览器,访问 `http://localhost:3000` 即可开始使用(若是远程部署,请访问 `http://<您的服务器IP>:3000`)。
### 方案二:通过 NPM / 包管理器安装
通过 NPM 上的 `@shumai-one/shumai` 进行安装。
#### 第一步:启动带 pgvector 支持的 PostgreSQL
Shumai 依赖支持 `pgvector` 扩展的 PostgreSQL 数据库。您可以使用 Docker 快速启动一个预配置好的数据库容器:
```bash
docker run --name shumai_postgres \
-e POSTGRES_USER=shumai \
-e POSTGRES_PASSWORD=shumai_password \
-e POSTGRES_DB=shumai_db \
-p 5432:5432 \
-d docker.m.daocloud.io/pgvector/pgvector:pg18
```
#### 第二步:创建工作区目录
创建一个专属目录用来存放环境配置和媒体文件(媒体文件默认会保存在 `./data` 目录下):
```bash
mkdir shumai && cd shumai
```
#### 步骤 3:安装平台依赖
#### Linux
在 Linux 上运行 Shumai 需要安装以下系统依赖:
- **`ffmpeg`** —— 用于媒体转码和元数据提取。
- **`poppler`** (`poppler-utils`) —— 用于 PDF 页面图像提取和 PDF 雪碧图预览生成 (`pdftoppm`)。
- **`imagemagick`** —— 用于 PSD 格式图像转码和 sRGB 色彩空间转换。
- **`bubblewrap`**、**`socat`** 和 **`ripgrep`** —— AI Agent 沙箱(`anthropic-experimental/sandbox-runtime`)所需,用于进程隔离、网络通信和工作区搜索。
可以使用以下命令一次性安装所有依赖:
> Ubuntu/Debian
```bash
sudo apt install -y ffmpeg poppler-utils imagemagick bubblewrap socat ripgrep
```
> Fedora
```bash
sudo dnf install -y ffmpeg poppler-utils ImageMagick bubblewrap socat ripgrep
```
> Arch Linux
```bash
sudo pacman -S --noconfirm ffmpeg poppler imagemagick bubblewrap socat ripgrep
```
> [!NOTE]
> **Ubuntu 24.04+** 默认限制非特权用户创建 User Namespace,这会导致 `anthropic-experimental/sandbox-runtime` 无法使用 `bubblewrap` 提供沙箱隔离。
>
> 如需临时启用 User Namespace,请执行:
>
> ```bash
> sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0
> ```
>
> 或者,配置 AppArmor Profile,为相关可执行文件授予所需的 `userns` 权限。
---
#### macOS
在 macOS 上运行 Shumai 需要:
- **`ffmpeg`** —— 用于媒体转码和元数据提取。
- **`poppler`** —— 用于 PDF 页面图像提取和 PDF 雪碧图预览生成 (`pdftoppm`)。
- **`imagemagick`** —— 用于 PSD 格式图像转码和 sRGB 色彩空间转换。
- **`ripgrep`** —— AI Agent 沙箱(`anthropic-experimental/sandbox-runtime`)所需。
使用 Homebrew 安装所需依赖:
```bash
brew install ffmpeg poppler imagemagick ripgrep
```
---
#### Windows(Alpha)
> [!WARNING]
> anthropic-experimental/sandbox-runtime 的 Windows 支持目前仍处于 **Alpha** 阶段,整体设计仍在持续调整中。
>
> 当前实现提供了以下能力:
> - 通过 **Windows Filtering Platform (WFP)** 实现网络出口(egress)过滤。
> - 通过 **ACL Stamping** 实现文件读写权限限制。
>
> **但这并不能作为针对恶意沙箱进程的安全边界(security boundary)**。
>
> 未来版本将对沙箱机制进行重大调整,届时沙箱进程将运行在独立的沙箱用户账户下。
在 Windows 上运行 Shumai 需要:
- **`ffmpeg`** —— 用于媒体转码和元数据提取。
- **`imagemagick`** —— 用于 PSD 格式图像转码和 sRGB 色彩空间转换。
使用你偏好的包管理器安装所需依赖:
**winget**
```powershell
winget install Gyan.FFmpeg ImageMagick.ImageMagick
```
**Chocolatey**
```powershell
choco install ffmpeg imagemagick
```
#### 第四步:全局安装 Shumai
使用您常用的包管理器进行全局安装:
```bash
# 使用 NPM
npm install -g @shumai-one/shumai
# 使用 PNPM
pnpm add -g @shumai-one/shumai
# 使用 Bun
bun add -g @shumai-one/shumai
```
#### 第五步:配置环境配置
在刚才创建的工作区目录(`shumai/`)下新建一个 `.env` 文件,并填入以下配置:
```env
DATABASE_URL=postgresql://shumai:shumai_password@localhost:5432/shumai_db?schema=public
BETTER_AUTH_SECRET=ySxs7DxzHDZBbeeHNPEwBuspYwipBqz5Gk5XdBjNhWw=
STORAGE_BACKEND=local
SHUMAI_SERVER_PORT=3000
AWS_ENDPOINT_URL_S3=http://localhost:3000
```
> [!NOTE]
> `SHUMAI_SERVER_PORT` 用于设置 Web 服务的启动端口,而 `AWS_ENDPOINT_URL_S3` 供浏览器端构建文件上传链接。
> 如果您部署在远程服务器(如 `http://123.456.7.8`)并且做了端口映射(如 Docker 中的 `12345:3000`),请将 `AWS_ENDPOINT_URL_S3` 设置为 `http://123.456.7.8:12345`。
#### 第六步:启动 Shumai
> [!IMPORTANT]
> **Bun 用户特别提示:** 由于发布的包二进制文件包含 `#!/usr/bin/env node` 头部声明(Shebang),直接在终端执行全局命令(例如 `shumai`)默认会通过 Node.js 运行。如果您是用 Bun 安装的并且希望调用 Bun 运行时,请在所有命令前加上 `bun run --bun` 前缀(例如:`bun run --bun shumai`、`bun run --bun shumai -d`、`bun run --bun shumai stop`)。
在您的工作区目录下执行以下命令启动应用:
```bash
shumai
```
您也可以让 Shumai 在后台以守护进程(Daemon)模式运行和管理:
* **后台模式启动**:
```bash
shumai -d
```
* **停止服务**:
```bash
shumai stop
```
* **重启服务**:
```bash
shumai restart
```
* **查看并跟踪实时日志**:
```bash
shumai logs
```
启动时,Shumai 会自动执行数据库迁移(Migration)并在 `http://localhost:3000` 拉起 Web 服务。
---
### 方案三:源码编译运行(开发环境)
如果您希望在本地参与 Shumai 的开发,请按以下步骤配置开发环境:
1. 克隆代码仓库并安装依赖项:
```bash
git clone [https://github.com/shumaiOne/shumai.git](https://github.com/shumaiOne/shumai.git)
cd shumai
bun install
```
2. 启动 `pgvector` 数据库容器(参考**方案二中的第一步**)。
3. 参照**方案二中的第五步**,在项目根目录下创建一个 `.env` 文件。
4. 生成多语言国际化(i18n)代码:
```bash
bun run i18n:compile
```
> [!TIP]
> 在前端开发过程中,可以在单独的终端窗口中运行 `bun run i18n:watch`,在修改 `packages/webui/messages/` 下的翻译文案时自动重新编译。
5. 执行数据库结构迁移:
```bash
bun run db:migrate
```
6. 启动本地开发服务器:
```bash
bun run dev
```
---
## 命令行工具 (CLI)
Shumai 自带一个功能完备的命令行工具(CLI),支持您直接在终端里高效管理项目、文件夹、资产,批量上传文件/目录,以及快速创建新版本。
关于 CLI 的安装与详细使用指南,请参阅 [CLI Readme](https://www.google.com/search?q=apps/cli/README.md)。
+58
View File
@@ -0,0 +1,58 @@
# Security Policy
## Reporting a Vulnerability
Please report security vulnerabilities **privately**. Do not open a public issue,
pull request or Discord message for a suspected vulnerability, as that discloses it
to everyone before a fix exists.
Use **[GitHub private vulnerability reporting](https://github.com/shumaiOne/shumai/security/advisories/new)**
(the "Report a vulnerability" button on the Security tab). If that is unavailable,
contact the maintainer directly rather than in a public channel.
Please include:
- What the issue is, and the impact you believe it has
- The version or commit you tested (`git rev-parse HEAD`, or the image digest)
- Steps to reproduce, ideally minimal
- Your deployment shape: storage backend, whether the agent feature is enabled,
and whether the instance is internet-reachable
## Supported Versions
Shumai is pre-1.0 and moves quickly. Security fixes are made against the **latest
release**. Users are encouraged to track releases rather than pin indefinitely.
## Scope
**In scope** — the application, its API, the shipped Docker images, and the
deployment manifests under `docker-compose/`.
Deployment manifests are explicitly in scope. A default that is unsafe when
followed as documented is a real finding, because the documented quickstart is what
most operators actually run.
**Out of scope**
- Vulnerabilities in third-party dependencies, unless Shumai's use of them is what
creates the exposure. Report those upstream.
- Findings that require an already-compromised host or database.
- Configurations that deviate from the documented deployment.
## Operator guidance
Shumai is self-hosted, so several controls belong to the operator rather than to the
project:
- **Set `BETTER_AUTH_SECRET` per deployment.** It signs sessions and, in local
storage mode, upload URLs. Never reuse a value from documentation or an example.
- **Do not expose the instance to the public internet without a reverse proxy**
terminating TLS and applying your own access policy.
- **Do not publish the database port.** Set a real database password.
- **Treat the agent feature as a code-execution surface.** If you enable it, run it
where a compromise is survivable, and review the sandbox network policy.
## Disclosure
Please allow a reasonable period for a fix before public disclosure. The maintainer
will acknowledge reports and keep reporters informed of progress.
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/agent-app",
"version": "0.0.9",
"version": "0.4.7",
"private": true,
"type": "module",
"bin": {
+4
View File
@@ -4,6 +4,7 @@ loadEnvConfig(process.cwd(), process.env.NODE_ENV !== 'production')
import { workflowService } from '@shumai/workflow-core'
import { TaskQueueAgent } from '@shumai/workflow-core'
import { initAgentWorkflows } from '@shumai/agent'
import { sandboxService } from '@shumai/core'
import { handleDaemonCommands } from '@shumai/core/src/utils/daemon'
if (process.argv.includes('--check')) {
@@ -14,6 +15,9 @@ if (process.argv.includes('--check')) {
async function run() {
// Initialize workflows and activities
initAgentWorkflows()
await sandboxService.ensureInitialized().catch((err) => {
console.error('Failed to eagerly initialize sandbox in agent worker:', err)
})
console.log('🚀 Starting Agent Worker...')
-1
View File
@@ -1,5 +1,4 @@
export * from '@shumai/agent/src/workflows/agent-autofill'
export * from '@shumai/agent/src/workflows/agent-chat'
export * from '@shumai/agent/src/workflows/agent-embedding'
export * from '@shumai/agent/src/workflows/agent-tool-call'
export * from '@shumai/agent/src/workflows/query-embedding-for-search'
+134
View File
@@ -0,0 +1,134 @@
# Shumai CLI
A Command Line Interface (CLI) tool for interacting with your Shumai instance.
The CLI allows you to view projects, list folder contents, create folders, upload files and directories, and create new versions of existing files directly from the terminal.
---
## Installation
The CLI package is bundled inside the Shumai workspace.
### Environment Setup
Before using the CLI, you must set the following environment variables to authenticate with your Shumai instance:
```bash
# The endpoint of your Shumai API server (e.g. http://localhost:3000)
export SHUMAI_API_SERVER="http://localhost:3000"
# Your personal API Token (Generate this in the WebUI via Settings -> Developer tab)
export SHUMAI_API_KEY="your-developer-api-token"
# Optional: Enable asset deletion capability (disabled by default for safety)
export SHUMAI_ALLOW_DELETE="true"
```
---
## Usage
> [!IMPORTANT]
> **For Bun Users:** Since the package binary contains a `#!/usr/bin/env node` shebang, running `shumai-cli` directly will run under Node.js. If you wish to run it using Bun, prefix the command with `bun run --bun` (e.g., `bun run --bun shumai-cli project ls`).
Run `shumai-cli` or query specific commands:
```bash
shumai-cli <command> [arguments] [options]
```
### Commands
#### 1. List Projects
List all projects you have access to. Returns the project ID, name, and its root folder ID.
```bash
shumai-cli project ls
```
#### 2. List Directory Contents
List direct children (folders and files) of a parent folder.
```bash
shumai-cli ls -p <parentId>
```
- **Options:**
- `-p`, `--parent <id>`: The parent folder ID (required).
#### 3. Create a New Folder
Create a new folder under a parent folder.
```bash
shumai-cli mkdir <name> -p <parentId>
```
- **Options:**
- `-p`, `--parent <id>`: The parent folder ID (required).
#### 4. Upload Files or Folders
Upload a local file or folder to a target parent folder. File sizes and paths are mapped, and uploads are streamed chunk-by-chunk with a progress bar.
```bash
shumai-cli upload <localPath> -p <parentId>
```
- **Options:**
- `-p`, `--parent <id>`: The parent folder ID (required).
#### 5. Create a New Version of a File
Upload a local file as a new version of an existing asset (which must be a file or a version stack). This wraps the assets into a version stack dynamically on the server.
```bash
shumai-cli create-version <localFilePath> -p <parentAssetId>
```
- **Options:**
- `-p`, `--parent <id>`: The parent asset ID (file or version stack) to version (required).
#### 6. Rename an Asset
Rename an existing file or folder in Shumai.
```bash
shumai-cli rename <assetId> <newName>
```
#### 7. Move Assets
Move one or more assets (files or folders) to a destination parent folder. Note that all assets to be moved must belong to the same current parent folder.
```bash
shumai-cli move <assetId...> -p <parentId>
# or using the short alias:
shumai-cli mv <assetId...> -p <parentId>
```
- **Options:**
- `-p`, `--parent <id>`: The destination parent folder ID (required).
#### 8. Delete an Asset
Delete a single file or folder by moving it to the Trash bin. For safety, this command only deletes one asset at a time and requires the `SHUMAI_ALLOW_DELETE="true"` environment variable to be set in your environment.
```bash
shumai-cli delete <assetId>
# or using the short alias:
shumai-cli rm <assetId>
```
---
## Development
To run the CLI in development mode inside the repository source code:
```bash
bun run apps/cli/src/index.ts project ls
```
+17
View File
@@ -0,0 +1,17 @@
{
"name": "@shumai/cli",
"version": "0.4.7",
"private": true,
"type": "module",
"bin": {
"shumai-cli": "./src/index.ts"
},
"dependencies": {
"@shumai/api": "workspace:*",
"@shumai/core": "workspace:*",
"@shumai/dtos": "workspace:*",
"@shumai/tableprinter": "workspace:*",
"hono": "4.13.5",
"ulid": "3.0.2"
}
}
+25
View File
@@ -0,0 +1,25 @@
import { hc } from 'hono/client'
import type { AppType } from '@shumai/api'
export function getClient() {
const apiKey = process.env.SHUMAI_API_KEY
const apiServer = process.env.SHUMAI_API_SERVER
if (!apiServer) {
console.error('Error: SHUMAI_API_SERVER environment variable is not set.')
process.exit(1)
}
if (!apiKey) {
console.error(
'Error: SHUMAI_API_KEY environment variable is not set. Please generate a token in the Settings -> Developer tab.',
)
process.exit(1)
}
return hc<AppType>(apiServer, {
headers: {
Authorization: `Bearer ${apiKey}`,
},
})
}
+574
View File
@@ -0,0 +1,574 @@
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest'
import { projectLs } from './project'
import { ls } from './ls'
import { mkdir } from './mkdir'
import { getClient } from '../client'
import { upload } from './upload'
import { createVersion } from './create-version'
import { rename } from './rename'
import { move } from './move'
import { deleteAsset } from './delete'
import fs from 'node:fs'
import http from 'node:http'
vi.mock('../client', () => ({
getClient: vi.fn(),
}))
vi.mock('node:http', () => ({
default: {
request: vi.fn(),
},
}))
describe('CLI Commands', () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let logSpy: any
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let writeSpy: any
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let errorSpy: any
// eslint-disable-next-line @typescript-eslint/no-explicit-any
let exitSpy: any
const mockClient = {
api: {
projects: {
$get: vi.fn(),
':projectId': {
$get: vi.fn(),
reparent: {
$post: vi.fn(),
},
},
},
folders: {
$post: vi.fn(),
$delete: vi.fn(),
':folderId': {
$get: vi.fn(),
$put: vi.fn(),
children: {
$get: vi.fn(),
},
},
},
files: {
$delete: vi.fn(),
':fileId': {
$get: vi.fn(),
$put: vi.fn(),
},
},
teams: {
':teamId': {
upload: {
tasks: {
$post: vi.fn(),
':taskId': {
$patch: vi.fn(),
},
},
},
},
},
},
}
const originalAllowDelete = process.env.SHUMAI_ALLOW_DELETE
beforeEach(() => {
vi.resetAllMocks()
logSpy = vi.spyOn(console, 'log').mockImplementation(() => {})
writeSpy = vi.spyOn(process.stdout, 'write').mockImplementation(() => true)
errorSpy = vi.spyOn(console, 'error').mockImplementation(() => {})
exitSpy = vi
.spyOn(process, 'exit')
.mockImplementation((code?: string | number | null): never => {
throw new Error(`process.exit(${code})`)
})
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.mocked(getClient).mockReturnValue(mockClient as any)
})
afterEach(() => {
logSpy.mockRestore()
writeSpy.mockRestore()
errorSpy.mockRestore()
exitSpy.mockRestore()
if (originalAllowDelete !== undefined) {
process.env.SHUMAI_ALLOW_DELETE = originalAllowDelete
} else {
delete process.env.SHUMAI_ALLOW_DELETE
}
})
describe('project ls', () => {
it('prints list of projects correctly', async () => {
mockClient.api.projects.$get.mockResolvedValue({
ok: true,
json: async () => ({
data: [
{ id: 'p1', name: 'Proj 1', rootFolder: 'root1' },
{ id: 'p2', name: 'Proj 2', rootFolder: 'root2' },
],
}),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await projectLs()
expect(mockClient.api.projects.$get).toHaveBeenCalledWith({
query: { first: '200' },
})
expect(writeSpy).toHaveBeenCalledWith(expect.stringContaining('Proj 1'))
expect(writeSpy).toHaveBeenCalledWith(expect.stringContaining('Proj 2'))
})
})
describe('ls', () => {
it('queries folders and files and displays table', async () => {
mockClient.api.folders[':folderId'].children.$get
.mockResolvedValueOnce({
ok: true,
json: async () => ({
data: [{ id: 'subfolder1', name: 'Sub 1', type: 'folder', sizeByte: 0 }],
}),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
.mockResolvedValueOnce({
ok: true,
json: async () => ({
data: [{ id: 'file1', name: 'doc.pdf', type: 'file', sizeByte: 1024 }],
}),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await ls('parentId123')
expect(mockClient.api.folders[':folderId'].children.$get).toHaveBeenCalledTimes(2)
expect(writeSpy).toHaveBeenCalledWith(expect.stringContaining('Sub 1'))
expect(writeSpy).toHaveBeenCalledWith(expect.stringContaining('doc.pdf'))
})
})
describe('mkdir', () => {
it('calls POST /folders and prints the folder ID', async () => {
mockClient.api.folders.$post.mockResolvedValue({
ok: true,
json: async () => ({ id: 'new_folder_ulid' }),
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await mkdir('NewFolder', 'parent_ulid')
expect(mockClient.api.folders.$post).toHaveBeenCalledWith({
json: { name: 'NewFolder', parentId: 'parent_ulid' },
})
expect(logSpy).toHaveBeenCalledWith('Created folder with ID: new_folder_ulid')
})
})
describe('upload', () => {
it('uploads a file successfully and confirms the task', async () => {
const tempFile = 'temp-test-file.txt'
fs.writeFileSync(tempFile, 'hello world')
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ projectId: 'p123' }),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
mockClient.api.projects[':projectId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ teamId: 't123' }),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
mockClient.api.teams[':teamId'].upload.tasks.$post.mockImplementation(
async (req: unknown) => {
const rootNodeId = (req as { json: { files: { id: string }[] } }).json.files[0].id
return {
ok: true,
json: async () => ({
taskId: 'task123',
presignedUrls: [
{ id: rootNodeId, fileId: 'file-123', url: 'http://localhost/upload' },
],
createdAssets: [{ tempId: rootNodeId, assetId: 'file-123' }],
}),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any
},
)
mockClient.api.teams[':teamId'].upload.tasks[':taskId'].$patch.mockResolvedValue({
ok: true,
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const mockRes = {
statusCode: 200,
resume: vi.fn(),
}
let mockReqCallback: ((res: { statusCode: number; resume: () => void }) => void) | null = null
const mockReq = {
on: vi.fn().mockImplementation(() => {
return mockReq
}),
write: vi.fn(),
end: vi.fn().mockImplementation(() => {
if (mockReqCallback) {
mockReqCallback(mockRes)
}
}),
destroy: vi.fn(),
}
vi.mocked(http.request).mockImplementation(((
_options: unknown,
callback: (res: { statusCode: number; resume: () => void }) => void,
) => {
mockReqCallback = callback
return mockReq
// We use any here because we are mocking the http request function in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
}) as any)
await upload(tempFile, 'folder-123')
expect(mockClient.api.folders[':folderId'].$get).toHaveBeenCalledWith({
param: { folderId: 'folder-123' },
})
expect(mockClient.api.projects[':projectId'].$get).toHaveBeenCalledWith({
param: { projectId: 'p123' },
})
expect(mockClient.api.teams[':teamId'].upload.tasks.$post).toHaveBeenCalled()
expect(mockClient.api.teams[':teamId'].upload.tasks[':taskId'].$patch).toHaveBeenCalledWith({
param: { teamId: 't123', taskId: 'task123' },
json: { fileId: 'file-123' },
})
try {
fs.unlinkSync(tempFile)
} catch {
// Ignore if file doesn't exist
}
})
})
describe('create-version', () => {
it('fails if local path is a directory', async () => {
const tempDir = 'temp-test-dir'
fs.mkdirSync(tempDir, { recursive: true })
await expect(createVersion(tempDir, 'file-123')).rejects.toThrow('process.exit(1)')
try {
fs.rmdirSync(tempDir)
} catch {
// Ignore
}
})
it('fails if parent asset is not file or version_stack', async () => {
const tempFile = 'temp-test-file-ver.txt'
fs.writeFileSync(tempFile, 'hello ver')
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ type: 'folder', projectId: 'p123' }),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await expect(createVersion(tempFile, 'folder-123')).rejects.toThrow('process.exit(1)')
try {
fs.unlinkSync(tempFile)
} catch {
// Ignore
}
})
it('succeeds if parent asset is a file', async () => {
const tempFile = 'temp-test-file-ver.txt'
fs.writeFileSync(tempFile, 'hello ver')
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ type: 'file', projectId: 'p123' }),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
mockClient.api.projects[':projectId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ teamId: 't123' }),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
mockClient.api.teams[':teamId'].upload.tasks.$post.mockImplementation(
async (req: unknown) => {
const rootNodeId = (req as { json: { files: { id: string }[] } }).json.files[0].id
return {
ok: true,
json: async () => ({
taskId: 'task123',
presignedUrls: [
{ id: rootNodeId, fileId: 'file-123', url: 'http://localhost/upload' },
],
createdAssets: [{ tempId: rootNodeId, assetId: 'file-123' }],
}),
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any
},
)
mockClient.api.teams[':teamId'].upload.tasks[':taskId'].$patch.mockResolvedValue({
ok: true,
// We use any here because we are mocking the hono client response shape in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const mockRes = {
statusCode: 200,
resume: vi.fn(),
}
let mockReqCallback: ((res: { statusCode: number; resume: () => void }) => void) | null = null
const mockReq = {
on: vi.fn().mockImplementation(() => {
return mockReq
}),
write: vi.fn(),
end: vi.fn().mockImplementation(() => {
if (mockReqCallback) {
mockReqCallback(mockRes)
}
}),
destroy: vi.fn(),
}
vi.mocked(http.request).mockImplementation(((
_options: unknown,
callback: (res: { statusCode: number; resume: () => void }) => void,
) => {
mockReqCallback = callback
return mockReq
// We use any here because we are mocking the http request function in a unit test context
// eslint-disable-next-line @typescript-eslint/no-explicit-any
}) as any)
await createVersion(tempFile, 'file-123')
expect(mockClient.api.folders[':folderId'].$get).toHaveBeenCalledWith({
param: { folderId: 'file-123' },
})
expect(mockClient.api.teams[':teamId'].upload.tasks.$post).toHaveBeenCalledWith({
param: { teamId: 't123' },
json: expect.objectContaining({ parentId: 'file-123' }),
})
try {
fs.unlinkSync(tempFile)
} catch {
// Ignore
}
})
})
describe('rename', () => {
it('exits with error when assetId or newName is missing', async () => {
await expect(rename('', 'new-name')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('Asset ID is required'))
await expect(rename('asset-1', '')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('New name is required'))
})
it('renames a folder when asset type is folder', async () => {
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'f-1', type: 'folder' }),
} as unknown as Response)
mockClient.api.folders[':folderId'].$put.mockResolvedValue({
ok: true,
json: async () => ({ id: 'f-1', name: 'Renamed Folder' }),
} as unknown as Response)
await rename('f-1', 'Renamed Folder')
expect(mockClient.api.folders[':folderId'].$put).toHaveBeenCalledWith({
param: { folderId: 'f-1' },
json: { name: 'Renamed Folder' },
})
expect(logSpy).toHaveBeenCalledWith('Renamed asset f-1 to "Renamed Folder"')
})
it('renames a file when asset type is file', async () => {
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'file-1', type: 'file' }),
} as unknown as Response)
mockClient.api.files[':fileId'].$put.mockResolvedValue({
ok: true,
json: async () => ({ id: 'file-1', name: 'new.mp4' }),
} as unknown as Response)
await rename('file-1', 'new.mp4')
expect(mockClient.api.files[':fileId'].$put).toHaveBeenCalledWith({
param: { fileId: 'file-1' },
json: { name: 'new.mp4' },
})
expect(logSpy).toHaveBeenCalledWith('Renamed asset file-1 to "new.mp4"')
})
it('exits with error when asset fetch fails', async () => {
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: false,
json: async () => ({ error: 'Asset not found' }),
} as unknown as Response)
await expect(rename('unknown-id', 'name')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith('Error: Asset not found')
})
})
describe('move', () => {
it('exits with error when assetIds or parentId is missing', async () => {
await expect(move([], 'parent-1')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(
expect.stringContaining('At least one asset ID is required'),
)
await expect(move(['a-1'], '')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(
expect.stringContaining('Option -p/--parent <parentId> is required'),
)
})
it('successfully moves assets', async () => {
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'parent-1', projectId: 'proj-1' }),
} as unknown as Response)
mockClient.api.projects[':projectId'].reparent.$post.mockResolvedValue({
ok: true,
} as unknown as Response)
await move(['a-1', 'a-2'], 'parent-1')
expect(mockClient.api.projects[':projectId'].reparent.$post).toHaveBeenCalledWith({
param: { projectId: 'proj-1' },
json: {
assetIds: ['a-1', 'a-2'],
newParentId: 'parent-1',
},
})
expect(logSpy).toHaveBeenCalledWith('Moved 2 asset(s) to parent parent-1')
})
it('exits with error when destination parent is not found', async () => {
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: false,
json: async () => ({ error: 'Folder not found' }),
} as unknown as Response)
await expect(move(['a-1'], 'missing-parent')).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith('Error: Folder not found')
})
})
describe('deleteAsset', () => {
it('exits with error when SHUMAI_ALLOW_DELETE is not set or not true', async () => {
delete process.env.SHUMAI_ALLOW_DELETE
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(
'Error: Asset deletion is disabled in this environment.',
)
})
it('exits with error when assetIds is empty', async () => {
process.env.SHUMAI_ALLOW_DELETE = 'true'
await expect(deleteAsset([])).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('Asset ID is required'))
})
it('exits with error when more than one asset ID is passed', async () => {
process.env.SHUMAI_ALLOW_DELETE = 'true'
await expect(deleteAsset(['a-1', 'a-2'])).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith('Error: Can only delete one asset at a time.')
})
it('exits with error when asset is not found', async () => {
process.env.SHUMAI_ALLOW_DELETE = 'true'
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: false,
json: async () => ({ error: 'Asset not found' }),
} as unknown as Response)
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith('Error: Asset not found')
})
it('successfully deletes a file when SHUMAI_ALLOW_DELETE is true', async () => {
process.env.SHUMAI_ALLOW_DELETE = 'true'
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'a-1', type: 'file' }),
} as unknown as Response)
mockClient.api.files.$delete.mockResolvedValue({
ok: true,
} as unknown as Response)
await deleteAsset(['a-1'])
expect(mockClient.api.files.$delete).toHaveBeenCalledWith({
json: { ids: ['a-1'] },
})
expect(mockClient.api.folders.$delete).not.toHaveBeenCalled()
expect(logSpy).toHaveBeenCalledWith('Deleted asset a-1')
})
it('successfully deletes a folder when SHUMAI_ALLOW_DELETE is 1', async () => {
process.env.SHUMAI_ALLOW_DELETE = '1'
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'folder-1', type: 'folder' }),
} as unknown as Response)
mockClient.api.folders.$delete.mockResolvedValue({
ok: true,
} as unknown as Response)
await deleteAsset(['folder-1'])
expect(mockClient.api.folders.$delete).toHaveBeenCalledWith({
json: { ids: ['folder-1'] },
})
expect(logSpy).toHaveBeenCalledWith('Deleted asset folder-1')
})
it('exits with error when delete API returns an error', async () => {
process.env.SHUMAI_ALLOW_DELETE = 'true'
mockClient.api.folders[':folderId'].$get.mockResolvedValue({
ok: true,
json: async () => ({ id: 'a-1', type: 'file' }),
} as unknown as Response)
mockClient.api.files.$delete.mockResolvedValue({
ok: false,
json: async () => ({ error: 'Failed to delete' }),
} as unknown as Response)
await expect(deleteAsset(['a-1'])).rejects.toThrow('process.exit(1)')
expect(errorSpy).toHaveBeenCalledWith('Error: Failed to delete')
})
})
})
+155
View File
@@ -0,0 +1,155 @@
import fs from 'node:fs'
import path from 'node:path'
import { ulid } from 'ulid'
import { getClient } from '../client'
import { getMediaType, ProgressTracker, uploadFileWithProgress } from './upload'
export async function createVersion(localPath: string, parentId: string) {
if (!localPath) {
console.error('Error: Local file path is required.')
process.exit(1)
}
if (!parentId) {
console.error('Error: Parent ID (-p/--parent) is required.')
process.exit(1)
}
const resolvedPath = path.resolve(localPath)
if (!fs.existsSync(resolvedPath)) {
console.error(`Error: Local path "${resolvedPath}" does not exist.`)
process.exit(1)
}
const stat = fs.statSync(resolvedPath)
if (stat.isDirectory()) {
console.error(
`Error: Local path "${resolvedPath}" is a directory. create-version only supports uploading single files.`,
)
process.exit(1)
}
const client = getClient()
try {
console.log(`Checking parent asset ${parentId}...`)
const assetRes = await client.api.folders[':folderId'].$get({
param: { folderId: parentId },
})
if (!assetRes.ok) {
const err = (await assetRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error fetching parent asset details: ${err.error || 'Failed'}`)
process.exit(1)
}
const parentAsset = await assetRes.json()
if (parentAsset.type !== 'file' && parentAsset.type !== 'version_stack') {
console.error(
`Error: Parent asset must be a file or a version_stack (got "${parentAsset.type}").`,
)
process.exit(1)
}
const projectId = parentAsset.projectId
if (!projectId) {
console.error('Error: Parent asset does not belong to any project.')
process.exit(1)
}
const projectRes = await client.api.projects[':projectId'].$get({
param: { projectId },
})
if (!projectRes.ok) {
const err = (await projectRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error fetching project details: ${err.error || 'Failed'}`)
process.exit(1)
}
const project = await projectRes.json()
const teamId = project.teamId
const name = path.basename(resolvedPath)
const mediaType = getMediaType(name)
const fileNode = {
name,
id: ulid(),
size: stat.size,
children: [],
type: 'file',
mediaType,
}
console.log(`Creating new version task...`)
const taskRes = await client.api.teams[':teamId'].upload.tasks.$post({
param: { teamId },
json: {
parentId,
files: [fileNode],
},
})
if (!taskRes.ok) {
const err = (await taskRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error creating version task: ${err.error || 'Failed'}`)
process.exit(1)
}
const { taskId, presignedUrls, createdAssets } = await taskRes.json()
if (!presignedUrls || presignedUrls.length === 0) {
console.error('Error: Server did not return presigned upload URLs.')
process.exit(1)
}
const urlObj = presignedUrls[0]
const progress = new ProgressTracker()
progress.addUpload(urlObj.id, name, stat.size)
try {
await uploadFileWithProgress(urlObj.url, resolvedPath, mediaType, (bytes) => {
progress.updateProgress(urlObj.id, bytes)
})
const confirmRes = await client.api.teams[':teamId'].upload.tasks[':taskId'].$patch({
param: { teamId, taskId },
json: { fileId: urlObj.fileId },
})
if (!confirmRes.ok) {
throw new Error('Failed to confirm upload')
}
} catch (err) {
console.error(`\nFailed to upload ${name}:`, err instanceof Error ? err.message : err)
await client.api.teams[':teamId'].upload.tasks[':taskId']
.$patch({
param: { teamId, taskId },
json: {
fileId: urlObj.fileId,
errorMessage: err instanceof Error ? err.message : String(err),
},
})
.catch(() => {})
process.exit(1)
}
console.log('\nVersion upload completed!')
if (createdAssets && createdAssets.length > 0) {
console.log('Created version asset ID:')
for (const asset of createdAssets) {
if (asset.tempId === fileNode.id) {
console.log(`- ${asset.assetId}`)
}
}
}
} catch (err) {
console.error('\nError connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+62
View File
@@ -0,0 +1,62 @@
import { getClient } from '../client'
export async function deleteAsset(assetIds: string[]) {
const isAllowed =
process.env.SHUMAI_ALLOW_DELETE === 'true' || process.env.SHUMAI_ALLOW_DELETE === '1'
if (!isAllowed) {
console.error('Error: Asset deletion is disabled in this environment.')
process.exit(1)
}
if (!assetIds || assetIds.length === 0) {
console.error('Error: Asset ID is required. Usage: shumai-cli delete <assetId>')
process.exit(1)
}
if (assetIds.length > 1) {
console.error('Error: Can only delete one asset at a time.')
process.exit(1)
}
const assetId = assetIds[0]
const client = getClient()
try {
// Inspect asset to determine whether it is a folder or file
const getRes = await client.api.folders[':folderId'].$get({
param: { folderId: assetId },
})
if (!getRes.ok) {
const err = (await getRes.json().catch(() => ({ error: 'Asset not found' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Asset not found'}`)
process.exit(1)
}
const asset = await getRes.json()
const isFolder = asset.type === 'folder'
const res = isFolder
? await client.api.folders.$delete({
json: { ids: [assetId] },
})
: await client.api.files.$delete({
json: { ids: [assetId] },
})
if (!res.ok) {
const err = (await res.json().catch(() => ({ error: 'Failed to delete asset' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Failed to delete asset'}`)
process.exit(1)
}
console.log(`Deleted asset ${assetId}`)
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+87
View File
@@ -0,0 +1,87 @@
import { newTablePrinter, withTruncate } from '@shumai/tableprinter'
import type { AssetInfo } from '@shumai/dtos'
import { getClient } from '../client'
function formatSize(bytes: number): string {
if (bytes === 0) return '-'
const k = 1024
const sizes = ['B', 'KB', 'MB', 'GB', 'TB']
const i = Math.floor(Math.log(bytes) / Math.log(k))
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + ' ' + sizes[i]
}
export async function ls(parentId: string) {
if (!parentId) {
console.error('Error: Parent ID (-p/--parent) is required.')
process.exit(1)
}
const client = getClient()
try {
const [foldersRes, filesRes] = await Promise.all([
client.api.folders[':folderId'].children.$get({
param: { folderId: parentId },
query: { assetType: 'folder', first: '200' },
}),
client.api.folders[':folderId'].children.$get({
param: { folderId: parentId },
query: { assetType: 'file', first: '200' },
}),
])
if (!foldersRes.ok) {
const err = (await foldersRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Failed to list folders'}`)
process.exit(1)
}
if (!filesRes.ok) {
const err = (await filesRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Failed to list files'}`)
process.exit(1)
}
const foldersData = await foldersRes.json()
const filesData = await filesRes.json()
const folders = foldersData.data || []
const files = filesData.data || []
const items = [
...folders.map((f: AssetInfo) => ({ ...f, typeDisplay: 'folder' as const })),
...files.map((f: AssetInfo) => ({ ...f, typeDisplay: 'file' as const })),
]
if (items.length === 0) {
console.log('No assets found in this folder.')
return
}
const isTty = process.stdout.isTTY
const maxWidth = process.stdout.columns || 80
const tp = newTablePrinter(process.stdout, isTty, maxWidth)
tp.addHeader(['ID', 'Name', 'Type', 'Size'])
for (const item of items) {
tp.addField(item.id || '', withTruncate(null))
tp.addField(item.name || '')
tp.addField(item.typeDisplay, withTruncate(null))
tp.addField(
item.typeDisplay === 'folder' ? '-' : formatSize(item.sizeByte || 0),
withTruncate(null),
)
tp.endRow()
}
tp.render()
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+32
View File
@@ -0,0 +1,32 @@
import { getClient } from '../client'
export async function mkdir(name: string, parentId: string) {
if (!name) {
console.error('Error: Folder name is required.')
process.exit(1)
}
if (!parentId) {
console.error('Error: Parent ID (-p/--parent) is required.')
process.exit(1)
}
const client = getClient()
try {
const res = await client.api.folders.$post({
json: { name, parentId },
})
if (!res.ok) {
const err = (await res.json().catch(() => ({ error: 'Unknown error' }))) as { error?: string }
console.error(`Error: ${err.error || 'Failed to create folder'}`)
process.exit(1)
}
const created = await res.json()
console.log(`Created folder with ID: ${created.id}`)
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+59
View File
@@ -0,0 +1,59 @@
import { getClient } from '../client'
export async function move(assetIds: string[], parentId: string) {
if (!assetIds || assetIds.length === 0) {
console.error(
'Error: At least one asset ID is required. Usage: shumai-cli move <assetId...> -p <parentId>',
)
process.exit(1)
}
if (!parentId) {
console.error('Error: Option -p/--parent <parentId> is required.')
process.exit(1)
}
const client = getClient()
try {
// Fetch destination folder to get its projectId
const parentRes = await client.api.folders[':folderId'].$get({
param: { folderId: parentId },
})
if (!parentRes.ok) {
const err = (await parentRes.json().catch(() => ({ error: 'Parent folder not found' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Parent folder not found'}`)
process.exit(1)
}
const parentInfo = await parentRes.json()
const projectId = parentInfo.projectId
if (!projectId) {
console.error('Error: Destination parent folder is not associated with a project.')
process.exit(1)
}
const res = await client.api.projects[':projectId'].reparent.$post({
param: { projectId },
json: {
assetIds,
newParentId: parentId,
},
})
if (!res.ok) {
const err = (await res.json().catch(() => ({ error: 'Failed to move assets' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Failed to move assets'}`)
process.exit(1)
}
console.log(`Moved ${assetIds.length} asset(s) to parent ${parentId}`)
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+42
View File
@@ -0,0 +1,42 @@
import { newTablePrinter } from '@shumai/tableprinter'
import { getClient } from '../client'
export async function projectLs() {
const client = getClient()
try {
const res = await client.api.projects.$get({
query: { first: '200' },
})
if (!res.ok) {
const err = (await res.json().catch(() => ({ error: 'Unknown error' }))) as { error?: string }
console.error(`Error: ${err.error || 'Failed to list projects'}`)
process.exit(1)
}
const { data: projects } = await res.json()
if (projects.length === 0) {
console.log('No projects found.')
return
}
const isTty = process.stdout.isTTY
const maxWidth = process.stdout.columns || 80
const tp = newTablePrinter(process.stdout, isTty, maxWidth)
tp.addHeader(['ID', 'Name', 'Root Folder ID'])
for (const p of projects) {
tp.addField(p.id || '')
tp.addField(p.name || '')
tp.addField(p.rootFolder || '')
tp.endRow()
}
tp.render()
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+55
View File
@@ -0,0 +1,55 @@
import { getClient } from '../client'
export async function rename(assetId: string, newName: string) {
if (!assetId) {
console.error('Error: Asset ID is required. Usage: shumai-cli rename <assetId> <newName>')
process.exit(1)
}
if (!newName) {
console.error('Error: New name is required. Usage: shumai-cli rename <assetId> <newName>')
process.exit(1)
}
const client = getClient()
try {
// Determine whether asset is a folder or a file
const getRes = await client.api.folders[':folderId'].$get({
param: { folderId: assetId },
})
if (!getRes.ok) {
const err = (await getRes.json().catch(() => ({ error: 'Asset not found' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Asset not found'}`)
process.exit(1)
}
const asset = await getRes.json()
const isFolder = asset.type === 'folder'
const updateRes = isFolder
? await client.api.folders[':folderId'].$put({
param: { folderId: assetId },
json: { name: newName },
})
: await client.api.files[':fileId'].$put({
param: { fileId: assetId },
json: { name: newName },
})
if (!updateRes.ok) {
const err = (await updateRes.json().catch(() => ({ error: 'Failed to rename asset' }))) as {
error?: string
}
console.error(`Error: ${err.error || 'Failed to rename asset'}`)
process.exit(1)
}
console.log(`Renamed asset ${assetId} to "${newName}"`)
} catch (err) {
console.error('Error connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+334
View File
@@ -0,0 +1,334 @@
import fs from 'node:fs'
import fsPromises from 'node:fs/promises'
import http from 'node:http'
import https from 'node:https'
import path from 'node:path'
import { ulid } from 'ulid'
import { getClient } from '../client'
interface CliFileNode {
name: string
id: string
size: number
children: CliFileNode[]
type: 'file' | 'folder'
mediaType?: string
}
export function getMediaType(filename: string): string {
const ext = path.extname(filename).toLowerCase()
const mimeMap: Record<string, string> = {
'.png': 'image/png',
'.jpg': 'image/jpeg',
'.jpeg': 'image/jpeg',
'.gif': 'image/gif',
'.svg': 'image/svg+xml',
'.webp': 'image/webp',
'.mp4': 'video/mp4',
'.mkv': 'video/x-matroska',
'.mov': 'video/quicktime',
'.avi': 'video/x-msvideo',
'.webm': 'video/webm',
'.mp3': 'audio/mpeg',
'.wav': 'audio/wav',
'.ogg': 'audio/ogg',
'.txt': 'text/plain',
'.md': 'text/markdown',
'.markdown': 'text/markdown',
'.json': 'application/json',
'.pdf': 'application/pdf',
'.zip': 'application/zip',
'.tar': 'application/x-tar',
'.gz': 'application/gzip',
}
return mimeMap[ext] || 'application/octet-stream'
}
async function buildFileTree(
localPath: string,
fileMap: Map<string, { path: string; name: string; size: number; mediaType: string }>,
): Promise<CliFileNode> {
const stat = await fsPromises.stat(localPath)
const name = path.basename(localPath)
const id = ulid()
if (stat.isDirectory()) {
const childrenNames = await fsPromises.readdir(localPath)
const children: CliFileNode[] = []
for (const childName of childrenNames) {
if (childName.startsWith('.')) continue
const childNode = await buildFileTree(path.join(localPath, childName), fileMap)
children.push(childNode)
}
return {
name,
id,
size: 0,
children,
type: 'folder',
}
} else {
const mediaType = getMediaType(name)
fileMap.set(id, { path: localPath, name, size: stat.size, mediaType })
return {
name,
id,
size: stat.size,
children: [],
type: 'file',
mediaType,
}
}
}
export class ProgressTracker {
private uploads = new Map<string, { name: string; size: number; uploadedBytes: number }>()
private isTty = process.stdout.isTTY
private linesPrinted = 0
addUpload(id: string, name: string, size: number) {
this.uploads.set(id, { name, size, uploadedBytes: 0 })
if (this.isTty) {
console.log(`${name.padEnd(30)} [${'░'.repeat(20)}] 0%`)
this.linesPrinted++
console.log('')
this.linesPrinted++
}
}
updateProgress(id: string, uploadedBytes: number) {
const item = this.uploads.get(id)
if (!item) return
item.uploadedBytes = uploadedBytes
if (this.isTty) {
process.stdout.write('\x1B[' + this.linesPrinted + 'A')
this.linesPrinted = 0
for (const upload of this.uploads.values()) {
const pct =
upload.size > 0
? Math.min(Math.round((upload.uploadedBytes / upload.size) * 100), 100)
: 100
const barLength = 20
const filledLength = Math.round((pct / 100) * barLength)
const bar = '█'.repeat(filledLength) + '░'.repeat(barLength - filledLength)
console.log(`${upload.name.padEnd(30)} [${bar}] ${pct}%`)
this.linesPrinted++
console.log('')
this.linesPrinted++
}
} else {
const pct = item.size > 0 ? Math.min(Math.round((uploadedBytes / item.size) * 100), 100) : 100
if (pct === 100 || uploadedBytes === 0 || pct % 25 === 0) {
console.log(`Uploading ${item.name}: ${pct}%`)
}
}
}
}
export async function uploadFileWithProgress(
url: string,
filePath: string,
contentType: string,
onProgress: (bytesUploaded: number) => void,
) {
const stat = fs.statSync(filePath)
const totalSize = stat.size
const parsedUrl = new URL(url)
const isHttps = parsedUrl.protocol === 'https:'
const requestModule = isHttps ? https : http
const options = {
method: 'PUT',
hostname: parsedUrl.hostname,
port: parsedUrl.port || (isHttps ? 443 : 80),
path: parsedUrl.pathname + parsedUrl.search,
headers: {
'Content-Type': contentType,
'Content-Length': totalSize.toString(),
},
}
return new Promise<void>((resolve, reject) => {
const req = requestModule.request(options, (res) => {
res.resume()
if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300) {
resolve()
} else {
reject(new Error(`Failed to upload to S3: ${res.statusCode} ${res.statusMessage}`))
}
})
req.on('error', (err) => {
reject(err)
})
const fileStream = fs.createReadStream(filePath)
let bytesUploaded = 0
fileStream.on('data', (chunk) => {
bytesUploaded += chunk.length
onProgress(bytesUploaded)
req.write(chunk)
})
fileStream.on('end', () => {
req.end()
})
fileStream.on('error', (err) => {
req.destroy()
reject(err)
})
})
}
export async function upload(localPath: string, parentId: string) {
if (!localPath) {
console.error('Error: Local file/folder path is required.')
process.exit(1)
}
if (!parentId) {
console.error('Error: Parent ID (-p/--parent) is required.')
process.exit(1)
}
const resolvedPath = path.resolve(localPath)
if (!fs.existsSync(resolvedPath)) {
console.error(`Error: Local path "${resolvedPath}" does not exist.`)
process.exit(1)
}
const client = getClient()
try {
const parentRes = await client.api.folders[':folderId'].$get({
param: { folderId: parentId },
})
if (!parentRes.ok) {
const err = (await parentRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error fetching parent folder details: ${err.error || 'Failed'}`)
process.exit(1)
}
const parentFolder = await parentRes.json()
const projectId = parentFolder.projectId
if (!projectId) {
console.error('Error: Parent folder does not belong to any project.')
process.exit(1)
}
const projectRes = await client.api.projects[':projectId'].$get({
param: { projectId },
})
if (!projectRes.ok) {
const err = (await projectRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error fetching project details: ${err.error || 'Failed'}`)
process.exit(1)
}
const project = await projectRes.json()
const teamId = project.teamId
const fileMap = new Map<
string,
{ path: string; name: string; size: number; mediaType: string }
>()
const rootNode = await buildFileTree(resolvedPath, fileMap)
console.log(`Starting upload task for ${fileMap.size} files...`)
const taskRes = await client.api.teams[':teamId'].upload.tasks.$post({
param: { teamId },
json: {
parentId,
files: [rootNode],
},
})
if (!taskRes.ok) {
const err = (await taskRes.json().catch(() => ({ error: 'Unknown error' }))) as {
error?: string
}
console.error(`Error creating upload task: ${err.error || 'Failed'}`)
process.exit(1)
}
const { taskId, presignedUrls, createdAssets } = await taskRes.json()
const progress = new ProgressTracker()
for (const urlObj of presignedUrls) {
const fileMeta = fileMap.get(urlObj.id)
if (fileMeta) {
progress.addUpload(urlObj.id, fileMeta.name, fileMeta.size)
}
}
const concurrencyLimit = 3
const queue = [...presignedUrls]
const activeUploads: Promise<void>[] = []
const uploadNext = async (): Promise<void> => {
if (queue.length === 0) return
const urlObj = queue.shift()!
const fileMeta = fileMap.get(urlObj.id)!
try {
await uploadFileWithProgress(urlObj.url, fileMeta.path, fileMeta.mediaType, (bytes) => {
progress.updateProgress(urlObj.id, bytes)
})
const confirmRes = await client.api.teams[':teamId'].upload.tasks[':taskId'].$patch({
param: { teamId, taskId },
json: { fileId: urlObj.fileId },
})
if (!confirmRes.ok) {
throw new Error('Failed to confirm upload')
}
} catch (err) {
console.error(
`\nFailed to upload ${fileMeta.name}:`,
err instanceof Error ? err.message : err,
)
await client.api.teams[':teamId'].upload.tasks[':taskId']
.$patch({
param: { teamId, taskId },
json: {
fileId: urlObj.fileId,
errorMessage: err instanceof Error ? err.message : String(err),
},
})
.catch(() => {})
}
return uploadNext()
}
for (let i = 0; i < Math.min(concurrencyLimit, presignedUrls.length); i++) {
activeUploads.push(uploadNext())
}
await Promise.all(activeUploads)
console.log('\nUpload completed!')
if (createdAssets && createdAssets.length > 0) {
console.log('Uploaded asset IDs:')
const topLevelTempIds = new Set<string>()
topLevelTempIds.add(rootNode.id)
for (const asset of createdAssets) {
if (topLevelTempIds.has(asset.tempId)) {
console.log(`- ${asset.assetId}`)
}
}
}
} catch (err) {
console.error('\nError connecting to API server:', err instanceof Error ? err.message : err)
process.exit(1)
}
}
+140
View File
@@ -0,0 +1,140 @@
import { projectLs } from './commands/project'
import { ls } from './commands/ls'
import { mkdir } from './commands/mkdir'
import { upload } from './commands/upload'
import { createVersion } from './commands/create-version'
import { rename } from './commands/rename'
import { move } from './commands/move'
import { deleteAsset } from './commands/delete'
function printHelp() {
console.log(`
Usage: shumai-cli <command> [arguments] [options]
Commands:
project ls List all projects (returns id, name, root folder id)
ls -p <parentId> List direct children of a parent folder (returns id, name, type, size)
mkdir <name> -p <parentId> Create a new folder in a parent folder
upload <path> -p <parentId> Upload a local file or folder to a parent folder
create-version <path> -p <id> Create a new version of an existing file or version stack
rename <assetId> <newName> Rename an existing file or folder
move <assetIds...> -p <target> Move one or more assets to a destination parent folder (alias: mv)
delete <assetId> Delete a single file or folder (alias: rm)
Options:
-p, --parent <id> The parent folder/asset ID (required for ls, mkdir, upload, create-version, move)
-h, --help Show help details
`)
}
async function main() {
const args = process.argv.slice(2)
if (args.length === 0 || args.includes('-h') || args.includes('--help')) {
printHelp()
process.exit(0)
}
const cmd = args[0]
let parentId = ''
const parentIdx = args.findIndex((a) => a === '-p' || a === '--parent')
if (parentIdx !== -1 && parentIdx + 1 < args.length) {
parentId = args[parentIdx + 1]
}
const cleanArgs: string[] = []
for (let i = 0; i < args.length; i++) {
if (args[i] === '-p' || args[i] === '--parent') {
i++
} else {
cleanArgs.push(args[i])
}
}
if (cmd === 'project' && cleanArgs[1] === 'ls') {
await projectLs()
} else if (cmd === 'ls') {
if (!parentId) {
console.error('Error: Option -p/--parent <parentId> is required.')
process.exit(1)
}
await ls(parentId)
} else if (cmd === 'mkdir') {
const name = cleanArgs[1]
if (!name) {
console.error(
'Error: Folder name is required. Usage: shumai-cli mkdir <folderName> -p <parentId>',
)
process.exit(1)
}
if (!parentId) {
console.error('Error: Option -p/--parent <parentId> is required.')
process.exit(1)
}
await mkdir(name, parentId)
} else if (cmd === 'upload') {
const localPath = cleanArgs[1]
if (!localPath) {
console.error(
'Error: File/folder path is required. Usage: shumai-cli upload <localPath> -p <parentId>',
)
process.exit(1)
}
if (!parentId) {
console.error('Error: Option -p/--parent <parentId> is required.')
process.exit(1)
}
await upload(localPath, parentId)
} else if (cmd === 'create-version') {
const localPath = cleanArgs[1]
if (!localPath) {
console.error(
'Error: Local file path is required. Usage: shumai-cli create-version <localPath> -p <parentAssetId>',
)
process.exit(1)
}
if (!parentId) {
console.error('Error: Option -p/--parent <parentAssetId> is required.')
process.exit(1)
}
await createVersion(localPath, parentId)
} else if (cmd === 'rename') {
const assetId = cleanArgs[1]
const newName = cleanArgs[2]
if (!assetId || !newName) {
console.error(
'Error: Asset ID and new name are required. Usage: shumai-cli rename <assetId> <newName>',
)
process.exit(1)
}
await rename(assetId, newName)
} else if (cmd === 'move' || cmd === 'mv') {
const assetIds = cleanArgs.slice(1)
if (assetIds.length === 0) {
console.error(
'Error: At least one asset ID is required. Usage: shumai-cli move <assetId...> -p <parentId>',
)
process.exit(1)
}
if (!parentId) {
console.error('Error: Option -p/--parent <parentId> is required.')
process.exit(1)
}
await move(assetIds, parentId)
} else if (cmd === 'delete' || cmd === 'rm') {
const assetIds = cleanArgs.slice(1)
if (assetIds.length === 0) {
console.error('Error: Asset ID is required. Usage: shumai-cli delete <assetId>')
process.exit(1)
}
await deleteAsset(assetIds)
} else {
console.error(`Error: Unknown command "${cmd}". Run "shumai-cli --help" for usage.`)
process.exit(1)
}
}
main().catch((err) => {
console.error('Unexpected error:', err)
process.exit(1)
})
+4
View File
@@ -0,0 +1,4 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"]
}
+41
View File
@@ -0,0 +1,41 @@
# Premiere UXP Plugin Guidelines
## Component Library (Spectrum Web Components / SWC)
- **Always prefer SWC components if possible**: Use Spectrum Web Component React wrappers (`@swc-react/*`) and `@swc-uxp-wrappers/*` for UI elements (Button, ActionButton, Textfield, Card, Divider, ProgressCircle, StatusLight, Badge, Search, FieldLabel, HelpText, IllustratedMessage, ActionGroup, etc.) rather than hand-crafting custom HTML/CSS elements.
- **SWC Support**: `public/manifest.json` has `"featureFlags": { "enableSWCSupport": true }`.
- **Package Versions**: Keep SWC packages aligned at version `0.37.0` (matching Adobe UXP compatibility).
- **Bundler Aliases**: `build.ts` uses `swcAliasPlugin` with `aliases` from `@swc-uxp-wrappers/utils` to resolve internal SWC imports for Bun.
## Icons
- **Always use Spectrum Workflow Icons (`@spectrum-web-components/icons-workflow`)**: Never use external icon libraries like `lucide-react`.
- **Registration**: All workflow icons used must be imported and registered in `src/index.tsx` (e.g. `import '@spectrum-web-components/icons-workflow/icons/sp-icon-movie-camera.js'`). Note: Ensure the icon exists in `@spectrum-web-components/icons-workflow/icons/` (Spectrum 1 compatible) rather than only `icons-s2/` (which falls back to an empty circular DefaultIcon under Spectrum 1).
- **Typing**: Add custom element declarations to `src/declarations.d.ts` under both `declare namespace React.JSX` and `declare global.JSX.IntrinsicElements` with `SpIconCustomElementProps`.
## Adobe UXP Layout Engine Rules (Critical CSS Gotchas)
Adobe UXP's layout engine (Yoga-based) does **not** support several standard modern CSS features:
1. **No CSS Grid**:
- `display: grid` and `grid-template-columns` are **unsupported / invalid**.
- Always use Flexbox (`display: flex; flex-direction: row | column;`).
2. **No `aspect-ratio`**:
- `aspect-ratio` is invalid in UXP and collapses containers to `0px` height.
- Always specify explicit `width` and `height` on preview / thumbnail containers.
3. **No `box-sizing: border-box`**:
- `box-sizing` is not supported (UXP elements are natively border-box). Specifying it logs invalid property warnings.
4. **No `gap` in Flexbox**:
- `gap` is invalid in Premiere UXP flexbox. Items will render with 0px spacing.
- Use `margin-bottom` or `margin-right` on child items for spacing.
5. **Always Set `flex-shrink: 0` on List Items**:
- Flex children default to `flex-shrink: 1`. When rendering lists with many items (>10 items), flexbox squishes the items down to slivers instead of scrolling.
- Always add `flex-shrink: 0` and an explicit `min-height` to list row cards (`.project-row-card`, `.file-row-card`, `.item-row`, etc.).
6. **Scroll Containers**:
- Scrollable flex children (like `.view-content`) must have `min-height: 0` and `overflow-y: auto` to allow children to overflow and scroll vertically.
## Build and Packaging Commands
- **Build**: `bun run --filter @shumai/premiere-uxp build`
- **Watch mode**: `bun run --filter @shumai/premiere-uxp dev`
- **Package CCX**: `bun run --filter @shumai/premiere-uxp package` (outputs `apps/premiere-uxp/shumai-premiere.ccx`)
+109
View File
@@ -0,0 +1,109 @@
#!/usr/bin/env bun
import { cp, rm, mkdir } from 'node:fs/promises'
import { existsSync, watch } from 'node:fs'
import { $ } from 'bun'
import { aliases } from '@swc-uxp-wrappers/utils'
import type { BunPlugin } from 'bun'
const swcAliasPlugin: BunPlugin = {
name: 'swc-uxp-aliases',
setup(build) {
for (const [key, target] of Object.entries(aliases)) {
const escaped = key.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
const filter = new RegExp(`^${escaped}(/.*)?$`)
build.onResolve({ filter }, (args) => {
const subpath = args.path.slice(key.length)
const targetPath = target + subpath
try {
return { path: import.meta.resolveSync(targetPath) }
} catch {
return undefined
}
})
}
},
}
const isWatch = process.argv.includes('--watch')
const isPackage = process.argv.includes('--package')
async function build(): Promise<boolean> {
const start = performance.now()
try {
if (!existsSync('dist')) {
await mkdir('dist', { recursive: true })
}
// 1. Copy public assets (manifest, index.html, styles, icons)
await cp('public', 'dist', { recursive: true })
// 2. Bundle with Bun.build
const result = await Bun.build({
entrypoints: ['./src/index.tsx'],
outdir: './dist',
naming: 'index.js',
target: 'browser',
format: 'cjs',
sourcemap: 'external',
minify: false,
plugins: [swcAliasPlugin],
external: ['os', 'premierepro', 'uxp'],
define: {
'process.env.NODE_ENV': JSON.stringify('production'),
},
})
if (!result.success) {
console.error('❌ Build failed:')
for (const log of result.logs) {
console.error(log)
}
return false
}
const elapsed = (performance.now() - start).toFixed(1)
console.log(`✅ Build completed in ${elapsed}ms`)
// 3. Package .ccx if requested
if (isPackage) {
console.log('📦 Packaging shumai-premiere.ccx...')
if (existsSync('shumai-premiere.ccx')) {
await rm('shumai-premiere.ccx')
}
await $`cd dist && zip -r ../shumai-premiere.ccx . -x '*.map' -x '.DS_Store' -x '__MACOSX*'`
console.log('✅ Package created.')
}
return true
} catch (err) {
console.error('❌ Build error:', err)
return false
}
}
// Clean and run initial build
if (existsSync('dist')) {
await rm('dist', { recursive: true, force: true })
}
const success = await build()
if (!success && !isWatch) {
process.exit(1)
}
// Watch mode
if (isWatch) {
console.log('👀 Watching src/ and public/ for changes...')
let building = false
const triggerRebuild = async (dir: string) => {
if (building) return
building = true
setTimeout(async () => {
console.log(`\n🔄 Change detected in ${dir}, rebuilding...`)
await build()
building = false
}, 50)
}
watch('./src', { recursive: true }, () => triggerRebuild('src'))
watch('./public', { recursive: true }, () => triggerRebuild('public'))
}
+62
View File
@@ -0,0 +1,62 @@
{
"name": "@shumai/premiere-uxp",
"version": "0.4.7",
"private": true,
"type": "commonjs",
"scripts": {
"build": "bun run ./build.ts",
"dev": "bun run ./build.ts --watch",
"package": "bun run ./build.ts --package",
"clean": "rm -rf dist"
},
"dependencies": {
"@shumai/api": "workspace:*",
"@shumai/dtos": "workspace:*",
"@spectrum-web-components/action-menu": "0.37.0",
"@spectrum-web-components/badge": "0.37.0",
"@spectrum-web-components/icon": "1.12.2",
"@spectrum-web-components/icons-workflow": "1.12.2",
"@spectrum-web-components/menu": "0.37.0",
"@spectrum-web-components/progress-circle": "0.37.0",
"@spectrum-web-components/status-light": "0.37.0",
"@spectrum-web-components/theme": "0.37.0",
"@swc-react/action-button": "0.37.0",
"@swc-react/action-group": "0.37.0",
"@swc-react/action-menu": "0.37.0",
"@swc-react/badge": "0.37.0",
"@swc-react/button": "0.37.0",
"@swc-react/card": "0.37.0",
"@swc-react/divider": "0.37.0",
"@swc-react/field-label": "0.37.0",
"@swc-react/help-text": "0.37.0",
"@swc-react/illustrated-message": "0.37.0",
"@swc-react/menu": "0.37.0",
"@swc-react/progress-circle": "0.37.0",
"@swc-react/search": "0.37.0",
"@swc-react/status-light": "0.37.0",
"@swc-react/textfield": "0.37.0",
"@swc-react/theme": "0.37.0",
"@swc-uxp-wrappers/action-button": "2.0.0",
"@swc-uxp-wrappers/action-group": "2.0.0",
"@swc-uxp-wrappers/button": "2.0.0",
"@swc-uxp-wrappers/card": "2.0.0",
"@swc-uxp-wrappers/divider": "2.0.0",
"@swc-uxp-wrappers/field-label": "2.0.0",
"@swc-uxp-wrappers/help-text": "2.0.0",
"@swc-uxp-wrappers/illustrated-message": "2.0.0",
"@swc-uxp-wrappers/menu": "2.0.0",
"@swc-uxp-wrappers/overlay": "2.0.0",
"@swc-uxp-wrappers/popover": "2.0.0",
"@swc-uxp-wrappers/search": "2.0.0",
"@swc-uxp-wrappers/textfield": "2.0.0",
"@swc-uxp-wrappers/utils": "2.0.1",
"hono": "4.13.5",
"react": "19.2.8",
"react-dom": "19.2.8"
},
"devDependencies": {
"@adobe/premierepro": "26.3.0",
"@types/react": "19.2.18",
"@types/react-dom": "19.2.7"
}
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

+13
View File
@@ -0,0 +1,13 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Shumai</title>
<link rel="stylesheet" href="./styles.css" />
<script defer src="./index.js"></script>
</head>
<body>
<div id="root"></div>
</body>
</html>
+61
View File
@@ -0,0 +1,61 @@
{
"id": "com.shumai.premiere",
"name": "Shumai",
"shortname": "shumai",
"version": "0.1.0",
"main": "index.html",
"host": {
"app": "premierepro",
"minVersion": "25.1.0"
},
"manifestVersion": 5,
"featureFlags": {
"enableSWCSupport": true
},
"requiredPermissions": {
"network": {
"domains": "all"
},
"localFileSystem": "request",
"clipboard": "readAndWrite"
},
"entrypoints": [
{
"id": "shumaiPanel",
"type": "panel",
"minimumSize": {
"width": 320,
"height": 480
},
"maximumSize": {
"width": 2000,
"height": 2000
},
"preferredDockedSize": {
"width": 400,
"height": 720
},
"preferredFloatingSize": {
"width": 460,
"height": 780
},
"label": {
"default": "Shumai"
},
"icons": [
{
"width": 114,
"height": 114,
"path": "icons/icon.png"
}
]
}
],
"icons": [
{
"width": 114,
"height": 114,
"path": "icons/icon.png"
}
]
}
File diff suppressed because it is too large Load Diff
Binary file not shown.
+123
View File
@@ -0,0 +1,123 @@
import React, { useEffect, useState } from 'react'
import { Header } from './components/Header'
import { NavigationTabs, type MainTab } from './components/NavigationTabs'
import { AuthView } from './views/AuthView'
import { ProjectsView, ProjectSummary } from './views/ProjectsView'
import { FileListView } from './views/FileListView'
import { SequencesView } from './views/SequencesView'
import { getStoredCredentials, clearStoredCredentials } from './services/storage'
import { getAllSequenceLinksFromCache } from './services/linkStorage'
import { resetClient } from './api/client'
import { autoSyncService } from './services/autoSyncService'
import { ProgressCircle } from '@swc-react/progress-circle'
type AppView = 'auth' | 'projects' | 'files'
export const App: React.FC = () => {
const [view, setView] = useState<AppView>('auth')
const [mainTab, setMainTab] = useState<MainTab>('browse')
const [linkedCount, setLinkedCount] = useState<number>(0)
const [endpoint, setEndpoint] = useState<string>('')
const [apiKey, setApiKey] = useState<string>('')
const [selectedProject, setSelectedProject] = useState<ProjectSummary | null>(null)
const [initialLoading, setInitialLoading] = useState(true)
useEffect(() => {
const creds = getStoredCredentials()
if (creds && creds.endpoint && creds.apiKey) {
setEndpoint(creds.endpoint)
setApiKey(creds.apiKey)
setView('projects')
autoSyncService.start(creds.endpoint, creds.apiKey)
const cached = getAllSequenceLinksFromCache()
setLinkedCount(cached.length)
} else {
setView('auth')
}
setInitialLoading(false)
return () => {
autoSyncService.stop()
}
}, [])
const handleConnectSuccess = (newEndpoint: string, newApiKey: string) => {
setEndpoint(newEndpoint)
setApiKey(newApiKey)
setView('projects')
autoSyncService.start(newEndpoint, newApiKey)
}
const handleDisconnect = () => {
autoSyncService.stop()
clearStoredCredentials()
resetClient()
setEndpoint('')
setApiKey('')
setSelectedProject(null)
setView('auth')
setMainTab('browse')
}
const handleSelectProject = (project: ProjectSummary) => {
setSelectedProject(project)
setView('files')
setMainTab('browse')
}
const handleBackToProjects = () => {
setSelectedProject(null)
setView('projects')
setMainTab('browse')
}
if (initialLoading) {
return (
<div className="app-container">
<Header />
<div className="view-content" style={{ justifyContent: 'center', alignItems: 'center' }}>
<ProgressCircle indeterminate size="l" label="Loading Shumai..." />
</div>
</div>
)
}
return (
<div className="app-container">
<Header
endpoint={view !== 'auth' ? endpoint : undefined}
onDisconnect={view !== 'auth' ? handleDisconnect : undefined}
/>
{view !== 'auth' && (
<NavigationTabs activeTab={mainTab} onTabChange={setMainTab} linkedCount={linkedCount} />
)}
{view === 'auth' && (
<AuthView
initialEndpoint={endpoint || 'http://localhost:3000'}
initialApiKey={apiKey}
onConnectSuccess={handleConnectSuccess}
/>
)}
{view !== 'auth' && mainTab === 'sequences' && (
<SequencesView endpoint={endpoint} apiKey={apiKey} onLinkCountChange={setLinkedCount} />
)}
{view !== 'auth' && mainTab === 'browse' && view === 'projects' && (
<ProjectsView endpoint={endpoint} apiKey={apiKey} onSelectProject={handleSelectProject} />
)}
{view !== 'auth' && mainTab === 'browse' && view === 'files' && selectedProject && (
<FileListView
endpoint={endpoint}
apiKey={apiKey}
project={selectedProject}
onBackToProjects={handleBackToProjects}
onLinkCountChange={setLinkedCount}
/>
)}
</div>
)
}
+31
View File
@@ -0,0 +1,31 @@
import { hc } from 'hono/client'
import type { AppType } from '@shumai/api'
export type ShumaiClient = ReturnType<typeof hc<AppType>>
let currentClient: ShumaiClient | null = null
let currentKey = ''
export function getShumaiClient(endpoint: string, apiKey: string): ShumaiClient {
const normalizedEndpoint = endpoint.trim().replace(/\/+$/, '')
const cacheKey = `${normalizedEndpoint}::${apiKey}`
if (currentClient && currentKey === cacheKey) {
return currentClient
}
currentClient = hc<AppType>(normalizedEndpoint, {
headers: {
Authorization: `Bearer ${apiKey}`,
'x-api-key': apiKey,
},
})
currentKey = cacheKey
return currentClient
}
export function resetClient(): void {
currentClient = null
currentKey = ''
}
@@ -0,0 +1,61 @@
import React from 'react'
import { Divider } from '@swc-react/divider'
export interface BreadcrumbCrumb {
id: string
name: string
}
interface BreadcrumbProps {
projectName?: string
crumbs: BreadcrumbCrumb[]
onNavigateToProjects: () => void
onNavigateToCrumb: (index: number) => void
}
export const Breadcrumb: React.FC<BreadcrumbProps> = ({
projectName,
crumbs,
onNavigateToProjects,
onNavigateToCrumb,
}) => {
return (
<>
<nav className="breadcrumb-bar" aria-label="Folder Path">
<span className="breadcrumb-item" onClick={onNavigateToProjects} title="Back to Projects">
Projects
</span>
{projectName && (
<>
<span className="breadcrumb-separator">/</span>
<span
className={`breadcrumb-item ${crumbs.length === 0 ? 'active' : ''}`}
onClick={() => onNavigateToCrumb(-1)}
title={projectName}
>
{projectName}
</span>
</>
)}
{crumbs.map((crumb, idx) => {
const isLast = idx === crumbs.length - 1
return (
<React.Fragment key={crumb.id}>
<span className="breadcrumb-separator">/</span>
<span
className={`breadcrumb-item ${isLast ? 'active' : ''}`}
onClick={() => (!isLast ? onNavigateToCrumb(idx) : undefined)}
title={crumb.name}
>
{crumb.name}
</span>
</React.Fragment>
)
})}
</nav>
<Divider size="s" />
</>
)
}
@@ -0,0 +1,409 @@
// @vitest-environment happy-dom
import React from 'react'
import { describe, it, expect, vi, afterEach } from 'vitest'
import { render, screen, fireEvent, cleanup } from '@testing-library/react'
import {
getFileTypeCategory,
getAssetVersionLabel,
FileItem,
FileCardItem,
type AssetSummary,
} from './FileItem'
// Configure React 19 act environment for happy-dom
;(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true
describe('getFileTypeCategory', () => {
it('identifies folder type', () => {
const asset: AssetSummary = {
id: 'f1',
name: 'My Folder',
type: 'folder',
}
expect(getFileTypeCategory(asset)).toBe('folder')
})
it('identifies video by mimeType', () => {
const asset: AssetSummary = {
id: 'v1',
name: 'clip.dat',
type: 'file',
mimeType: 'video/mp4',
}
expect(getFileTypeCategory(asset)).toBe('video')
})
it('identifies video by extension', () => {
const extensions = ['mp4', 'mov', 'avi', 'mkv', 'm4v', 'webm']
for (const ext of extensions) {
const asset: AssetSummary = {
id: `v-${ext}`,
name: `sample.${ext}`,
type: 'file',
}
expect(getFileTypeCategory(asset)).toBe('video')
}
})
it('identifies audio by mimeType or extension', () => {
const asset1: AssetSummary = {
id: 'a1',
name: 'audio.raw',
type: 'file',
mimeType: 'audio/wav',
}
const asset2: AssetSummary = {
id: 'a2',
name: 'track.mp3',
type: 'file',
}
expect(getFileTypeCategory(asset1)).toBe('audio')
expect(getFileTypeCategory(asset2)).toBe('audio')
})
it('identifies image by mimeType or extension', () => {
const asset1: AssetSummary = {
id: 'i1',
name: 'photo.bin',
type: 'file',
mimeType: 'image/png',
}
const asset2: AssetSummary = {
id: 'i2',
name: 'art.jpg',
type: 'file',
}
expect(getFileTypeCategory(asset1)).toBe('image')
expect(getFileTypeCategory(asset2)).toBe('image')
})
it('falls back to generic file', () => {
const asset: AssetSummary = {
id: 'doc1',
name: 'notes.pdf',
type: 'file',
mimeType: 'application/pdf',
}
expect(getFileTypeCategory(asset)).toBe('file')
})
})
describe('FileItem and FileCardItem UI Components', () => {
afterEach(() => {
cleanup()
vi.clearAllMocks()
})
const mockOnClick = vi.fn()
const mockOnImportRaw = vi.fn()
const mockOnSelectVideoForImport = vi.fn()
const folderAsset: AssetSummary = {
id: 'folder-1',
name: 'Raw Footage',
type: 'folder',
fileCount: 5,
}
const imageAsset: AssetSummary = {
id: 'img-1',
name: 'logo.png',
type: 'file',
mimeType: 'image/png',
sizeByte: 2048,
}
const videoAsset: AssetSummary = {
id: 'vid-1',
name: 'interview.mp4',
type: 'file',
mimeType: 'video/mp4',
sizeByte: 50 * 1024 * 1024,
}
it('FileItem navigates into folder on click without download button', () => {
render(
<FileItem
asset={folderAsset}
onClick={mockOnClick}
onImportRaw={mockOnImportRaw}
onSelectVideoForImport={mockOnSelectVideoForImport}
/>,
)
expect(screen.getByText('Raw Footage')).toBeTruthy()
expect(screen.queryByTitle('Import into Premiere Pro')).toBeNull()
fireEvent.click(screen.getByText('Raw Footage'))
expect(mockOnClick).toHaveBeenCalled()
expect(mockOnImportRaw).not.toHaveBeenCalled()
})
it('FileCardItem calls onImportRaw when download button is clicked for non-video, but clicking card does not', () => {
render(
<FileCardItem
asset={imageAsset}
onClick={mockOnClick}
onImportRaw={mockOnImportRaw}
onSelectVideoForImport={mockOnSelectVideoForImport}
/>,
)
expect(screen.getByText('logo.png')).toBeTruthy()
// Clicking the file title / card text should NOT trigger import
fireEvent.click(screen.getByText('logo.png'))
expect(mockOnImportRaw).not.toHaveBeenCalled()
const downloadBtn = screen.getByTitle('Import into Premiere Pro')
expect(downloadBtn).toBeTruthy()
fireEvent.click(downloadBtn)
expect(mockOnImportRaw).toHaveBeenCalledWith(imageAsset)
})
it('FileCardItem calls onSelectVideoForImport when download button is clicked for video', () => {
render(
<FileCardItem
asset={videoAsset}
onClick={mockOnClick}
onImportRaw={mockOnImportRaw}
onSelectVideoForImport={mockOnSelectVideoForImport}
/>,
)
expect(screen.getByText('interview.mp4')).toBeTruthy()
const downloadBtn = screen.getByTitle('Import into Premiere Pro')
fireEvent.click(downloadBtn)
expect(mockOnSelectVideoForImport).toHaveBeenCalledWith(videoAsset)
expect(mockOnImportRaw).not.toHaveBeenCalled()
})
it('FileCardItem renders sp-icon-link when isLinked is false, and triggers onLinkSequence on click', () => {
const mockOnLinkSequence = vi.fn()
const { container } = render(
<FileCardItem
asset={videoAsset}
onClick={mockOnClick}
onLinkSequence={mockOnLinkSequence}
isLinked={false}
/>,
)
const linkIcon = container.querySelector('sp-icon-link')
const unlinkIcon = container.querySelector('sp-icon-unlink')
expect(linkIcon).toBeTruthy()
expect(unlinkIcon).toBeNull()
const linkBtn = screen.getByTitle('Link to Sequence')
expect(linkBtn).toBeTruthy()
fireEvent.click(linkBtn)
expect(mockOnLinkSequence).toHaveBeenCalledWith(videoAsset)
})
it('FileCardItem renders sp-icon-unlink when isLinked is true, and triggers onUnlinkSequence on click', () => {
const mockOnLinkSequence = vi.fn()
const mockOnUnlinkSequence = vi.fn()
const { container } = render(
<FileCardItem
asset={videoAsset}
onClick={mockOnClick}
onLinkSequence={mockOnLinkSequence}
onUnlinkSequence={mockOnUnlinkSequence}
isLinked={true}
linkedSequenceName="Cut_v1"
/>,
)
const linkIcon = container.querySelector('sp-icon-link')
const unlinkIcon = container.querySelector('sp-icon-unlink')
expect(linkIcon).toBeNull()
expect(unlinkIcon).toBeTruthy()
const unlinkBtn = screen.getByTitle('Unlink from Cut_v1')
expect(unlinkBtn).toBeTruthy()
fireEvent.click(unlinkBtn)
expect(mockOnUnlinkSequence).toHaveBeenCalledWith(videoAsset)
expect(mockOnLinkSequence).not.toHaveBeenCalled()
})
it('FileItem renders sp-icon-unlink when isLinked is true', () => {
const mockOnLinkSequence = vi.fn()
const mockOnUnlinkSequence = vi.fn()
const { container } = render(
<FileItem
asset={videoAsset}
onClick={mockOnClick}
onLinkSequence={mockOnLinkSequence}
onUnlinkSequence={mockOnUnlinkSequence}
isLinked={true}
linkedSequenceName="Cut_v1"
/>,
)
const linkIcon = container.querySelector('sp-icon-link')
const unlinkIcon = container.querySelector('sp-icon-unlink')
expect(linkIcon).toBeNull()
expect(unlinkIcon).toBeTruthy()
const unlinkBtn = screen.getByTitle('Unlink from Cut_v1')
expect(unlinkBtn).toBeTruthy()
fireEvent.click(unlinkBtn)
expect(mockOnUnlinkSequence).toHaveBeenCalledWith(videoAsset)
})
it('FileCardItem renders version in details when asset has versionStack', () => {
const versionedAsset: AssetSummary = {
id: 'vid-v2',
name: 'interview_cut.mp4',
type: 'file',
mimeType: 'video/mp4',
sizeByte: 20 * 1024 * 1024,
versionStack: {
id: 'stack-1',
versions: [
{ version: 2, current: true, id: 'vid-v2', name: 'interview_cut.mp4' },
{ version: 1, current: false, id: 'vid-v1', name: 'interview_cut_v1.mp4' },
],
},
}
render(<FileCardItem asset={versionedAsset} onClick={mockOnClick} />)
expect(screen.getByText('v2')).toBeTruthy()
})
it('FileCardItem does not render version when asset has no versionStack', () => {
render(<FileCardItem asset={videoAsset} onClick={mockOnClick} />)
expect(screen.queryByText(/^v\d+$/)).toBeNull()
})
it('FileItem renders version in subtext when asset has versionStack', () => {
const versionedAsset: AssetSummary = {
id: 'vid-v2',
name: 'interview_cut.mp4',
type: 'file',
mimeType: 'video/mp4',
sizeByte: 20 * 1024 * 1024,
versionStack: {
id: 'stack-1',
versions: [
{ version: 2, current: true, id: 'vid-v2', name: 'interview_cut.mp4' },
{ version: 1, current: false, id: 'vid-v1', name: 'interview_cut_v1.mp4' },
],
},
}
render(<FileItem asset={versionedAsset} onClick={mockOnClick} />)
expect(screen.getByText(/v2 •/)).toBeTruthy()
})
it('FileCardItem renders createdAt time when provided', () => {
const assetWithDates: AssetSummary = {
id: 'date-1',
name: 'render.mp4',
type: 'file',
createdAt: new Date(Date.now() - 3600 * 1000).toISOString(),
updatedAt: new Date(Date.now() - 60 * 1000).toISOString(),
}
render(<FileCardItem asset={assetWithDates} onClick={mockOnClick} />)
expect(screen.getByText('1h ago')).toBeTruthy()
expect(screen.queryByText('1m ago')).toBeNull()
})
it('FileCardItem falls back to updatedAt if createdAt is absent', () => {
const assetWithUpdatedOnly: AssetSummary = {
id: 'date-2',
name: 'render2.mp4',
type: 'file',
updatedAt: new Date(Date.now() - 60 * 1000).toISOString(),
}
render(<FileCardItem asset={assetWithUpdatedOnly} onClick={mockOnClick} />)
expect(screen.getByText('1m ago')).toBeTruthy()
})
it('FileItem renders createdAt time in subtext when provided', () => {
const assetWithDates: AssetSummary = {
id: 'date-3',
name: 'render3.mp4',
type: 'file',
createdAt: new Date(Date.now() - 3600 * 1000).toISOString(),
updatedAt: new Date(Date.now() - 60 * 1000).toISOString(),
}
render(<FileItem asset={assetWithDates} onClick={mockOnClick} />)
expect(screen.getByText(/1h ago/)).toBeTruthy()
expect(screen.queryByText(/1m ago/)).toBeNull()
})
})
describe('getAssetVersionLabel', () => {
it('returns null for folder asset', () => {
const folder: AssetSummary = {
id: 'f1',
name: 'Footage',
type: 'folder',
}
expect(getAssetVersionLabel(folder)).toBeNull()
})
it('returns null for standalone file without versionStack', () => {
const file: AssetSummary = {
id: 'file1',
name: 'clip.mp4',
type: 'file',
}
expect(getAssetVersionLabel(file)).toBeNull()
})
it('returns null when versionStack has empty versions array', () => {
const file: AssetSummary = {
id: 'file1',
name: 'clip.mp4',
type: 'file',
versionStack: {
id: 'stack-1',
versions: [],
},
}
expect(getAssetVersionLabel(file)).toBeNull()
})
it('returns formatted version matching asset id', () => {
const file: AssetSummary = {
id: 'ver-1',
name: 'cut.mov',
type: 'file',
versionStack: {
id: 'stack-1',
versions: [
{ version: 3, current: false, id: 'ver-3' },
{ version: 2, current: false, id: 'ver-2' },
{ version: 1, current: false, id: 'ver-1' },
],
},
}
expect(getAssetVersionLabel(file)).toBe('v1')
})
it('returns current version when asset id is stack id or does not match', () => {
const file: AssetSummary = {
id: 'stack-1',
name: 'cut.mov',
type: 'version_stack',
versionStack: {
id: 'stack-1',
versions: [
{ version: 3, current: true, id: 'ver-3' },
{ version: 2, current: false, id: 'ver-2' },
{ version: 1, current: false, id: 'ver-1' },
],
},
}
expect(getAssetVersionLabel(file)).toBe('v3')
})
})
@@ -0,0 +1,503 @@
import React, { useState } from 'react'
import { formatDateAgo } from '../utils/date'
import { formatBytes, formatDuration } from '../utils/format'
import { resolveAssetUrl } from '../utils/url'
export { formatBytes, formatDuration }
export interface AssetSummary {
id: string
name: string
type: string
size?: number | null
sizeByte?: number | null
mimeType?: string | null
updatedAt?: string | Date
createdAt?: string | Date
commentsCount?: number
fileCount?: number
creator?: {
id: string
name: string
image?: string | null
} | null
agent?: {
id: string
name: string
} | null
preview?: {
thumbnailUrl?: string
duration?: number
pageCount?: number
proxyType?: string | null
} | null
media?: {
original?: {
key?: string
filesizeInBytes?: number
codec?: string
} | null
metadata?: {
duration?: number
}
videoTranscodes?: Array<{
id: string
url: string
key: string
width: number
height: number
size: number
}>
} | null
versionStack?: {
id: string
versions: Array<{
version: number
current: boolean
id: string
name?: string | null
createdAt?: string | null
previewUrl?: string | null
}>
} | null
}
export interface FileItemProps {
asset: AssetSummary
endpoint?: string
apiKey?: string
onClick: (e: React.MouseEvent) => void
onImportRaw?: (asset: AssetSummary) => void
onSelectVideoForImport?: (asset: AssetSummary) => void
onLinkSequence?: (asset: AssetSummary) => void
onUnlinkSequence?: (asset: AssetSummary) => void
isLinked?: boolean
linkedSequenceName?: string
}
export function getFileTypeCategory(
asset: AssetSummary,
): 'folder' | 'video' | 'audio' | 'image' | 'file' {
if (asset.type === 'folder') return 'folder'
const name = asset.name.toLowerCase()
const mime = asset.mimeType?.toLowerCase() || ''
if (mime.startsWith('video/') || /\.(mp4|mov|avi|mkv|m4v|webm)$/.test(name)) {
return 'video'
}
if (mime.startsWith('audio/') || /\.(mp3|wav|aac|flac|m4a|ogg)$/.test(name)) {
return 'audio'
}
if (mime.startsWith('image/') || /\.(png|jpg|jpeg|gif|webp|svg|bmp)$/.test(name)) {
return 'image'
}
return 'file'
}
export function getAssetVersionLabel(asset: AssetSummary): string | null {
if (asset.versionStack?.versions && asset.versionStack.versions.length > 0) {
const matched = asset.versionStack.versions.find((v) => v.id === asset.id)
if (matched?.version != null) {
return `v${matched.version}`
}
const current = asset.versionStack.versions.find((v) => v.current)
if (current?.version != null) {
return `v${current.version}`
}
const first = asset.versionStack.versions[0]
if (first?.version != null) {
return `v${first.version}`
}
return `v${asset.versionStack.versions.length}`
}
return null
}
/** List View Row Item */
export const FileItem: React.FC<FileItemProps> = ({
asset,
endpoint = '',
onClick,
onImportRaw,
onSelectVideoForImport,
onLinkSequence,
onUnlinkSequence,
isLinked = false,
linkedSequenceName,
}) => {
const [imgError, setImgError] = useState(false)
const category = getFileTypeCategory(asset)
const isFolder = category === 'folder'
const versionLabel = getAssetVersionLabel(asset)
const effectiveSize = asset.sizeByte ?? asset.size
const timeText = formatDateAgo(asset.createdAt || asset.updatedAt)
const thumbUrl = resolveAssetUrl(asset.preview?.thumbnailUrl, endpoint)
const iconFallback = (
<div className={`item-icon ${category}`}>
{category === 'folder' && (
<sp-icon-folder size="s" style={{ color: '#fbbf24' }}></sp-icon-folder>
)}
{category === 'video' && (
<sp-icon-filmstrip size="s" style={{ color: '#60a5fa' }}></sp-icon-filmstrip>
)}
{category === 'audio' && (
<sp-icon-audio size="s" style={{ color: '#a78bfa' }}></sp-icon-audio>
)}
{category === 'image' && (
<sp-icon-image size="s" style={{ color: '#f472b6' }}></sp-icon-image>
)}
{category === 'file' && (
<sp-icon-document size="s" style={{ color: '#999999' }}></sp-icon-document>
)}
</div>
)
const handleImportAction = () => {
if (isFolder) return
if (category === 'video' && onSelectVideoForImport) {
onSelectVideoForImport(asset)
} else if (onImportRaw) {
onImportRaw(asset)
}
}
const handleRowClick = (e: React.MouseEvent) => {
if (isFolder) {
onClick(e)
} else {
e.stopPropagation()
handleImportAction()
}
}
return (
<div
className="item-row"
onClick={handleRowClick}
role="button"
tabIndex={0}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
handleRowClick(e as unknown as React.MouseEvent)
}
}}
>
<div className="item-left">
{thumbUrl && !isFolder && !imgError ? (
<div className="item-thumb-wrapper">
<img
src={thumbUrl}
alt={asset.name}
className="item-thumb-img"
onLoad={() => console.log('[UXP Image OK]', thumbUrl)}
onError={() => {
console.error('[UXP Image Failed]', thumbUrl)
setImgError(true)
}}
/>
</div>
) : (
iconFallback
)}
<div className="item-meta">
<span className="item-name" title={asset.name}>
{asset.name}
</span>
<span className="item-subtext">
{versionLabel ? `${versionLabel} • ` : ''}
{isFolder ? 'Folder' : formatBytes(effectiveSize)}
{timeText ? ` • ${timeText}` : ''}
</span>
</div>
</div>
<div className="item-right">
{asset.commentsCount != null && asset.commentsCount > 0 && (
<span className="item-comments-count" title={`${asset.commentsCount} comments`}>
{asset.commentsCount} {asset.commentsCount === 1 ? 'comment' : 'comments'}
</span>
)}
{isFolder ? (
<sp-icon-chevron-right size="xs"></sp-icon-chevron-right>
) : (
<div style={{ display: 'flex', alignItems: 'center' }}>
{(onLinkSequence || onUnlinkSequence) &&
(category === 'video' || category === 'audio') && (
<sp-action-button
quiet
size="xs"
icon-only
label={
isLinked
? onUnlinkSequence
? `Unlink from ${linkedSequenceName || 'Sequence'}`
: `Linked to ${linkedSequenceName || 'Sequence'}`
: 'Link to Sequence'
}
title={
isLinked
? onUnlinkSequence
? `Unlink from ${linkedSequenceName || 'Sequence'}`
: `Linked to ${linkedSequenceName || 'Sequence'}`
: 'Link to Sequence'
}
className="item-row-link-btn"
style={{ marginRight: 4 }}
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
if (isLinked && onUnlinkSequence) {
onUnlinkSequence(asset)
} else if (onLinkSequence) {
onLinkSequence(asset)
}
}}
>
{isLinked ? (
<sp-icon-unlink
size="s"
slot="icon"
style={{ color: '#f87171' }}
></sp-icon-unlink>
) : (
<sp-icon-link size="s" slot="icon"></sp-icon-link>
)}
</sp-action-button>
)}
{(onImportRaw || onSelectVideoForImport) && (
<sp-action-button
quiet
size="xs"
icon-only
label="Import into Premiere Pro"
title="Import into Premiere Pro"
className="item-row-import-btn"
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
handleImportAction()
}}
>
<sp-icon-download size="s" slot="icon"></sp-icon-download>
</sp-action-button>
)}
</div>
)}
</div>
</div>
)
}
/** Card View Row Item (2 Columns: Left Preview, Right Info as Raw Text) */
export const FileCardItem: React.FC<FileItemProps> = ({
asset,
endpoint = '',
onClick,
onImportRaw,
onSelectVideoForImport,
onLinkSequence,
onUnlinkSequence,
isLinked = false,
linkedSequenceName,
}) => {
const [imgError, setImgError] = useState(false)
const category = getFileTypeCategory(asset)
const isFolder = category === 'folder'
const effectiveSize = asset.sizeByte ?? asset.size
const timeText = formatDateAgo(asset.createdAt || asset.updatedAt)
const thumbUrl = resolveAssetUrl(asset.preview?.thumbnailUrl, endpoint)
const duration = asset.preview?.duration ?? asset.media?.metadata?.duration
const durationText = formatDuration(duration)
const creatorName = asset.creator?.name || asset.agent?.name
const cardFallback = (
<div className={`file-row-placeholder ${category}`}>
{category === 'folder' && (
<sp-icon-folder size="l" style={{ color: '#fbbf24' }}></sp-icon-folder>
)}
{category === 'video' && (
<sp-icon-filmstrip size="l" style={{ color: '#60a5fa' }}></sp-icon-filmstrip>
)}
{category === 'audio' && (
<sp-icon-audio size="l" style={{ color: '#a78bfa' }}></sp-icon-audio>
)}
{category === 'image' && (
<sp-icon-image size="l" style={{ color: '#f472b6' }}></sp-icon-image>
)}
{category === 'file' && (
<sp-icon-document size="l" style={{ color: '#999999' }}></sp-icon-document>
)}
</div>
)
const handleImportAction = () => {
if (isFolder) return
if (category === 'video' && onSelectVideoForImport) {
onSelectVideoForImport(asset)
} else if (onImportRaw) {
onImportRaw(asset)
}
}
const handleCardClick = (e: React.MouseEvent) => {
if (isFolder) {
onClick(e)
}
}
// Assemble raw text details for Line 3 (Version • Duration • Size/Type • Comments)
const details: string[] = []
const versionLabel = getAssetVersionLabel(asset)
if (versionLabel) {
details.push(versionLabel)
}
if (durationText) {
details.push(durationText)
}
if (isFolder) {
details.push(asset.fileCount != null ? `${asset.fileCount} items` : 'Folder')
} else if (effectiveSize != null) {
details.push(formatBytes(effectiveSize))
}
if (asset.commentsCount != null && asset.commentsCount > 0) {
details.push(`${asset.commentsCount} ${asset.commentsCount === 1 ? 'comment' : 'comments'}`)
}
if (isLinked) {
details.push(`Linked: ${linkedSequenceName || 'Sequence'}`)
}
return (
<div
className={`file-row-card ${isFolder ? 'is-folder' : 'is-file'}`}
onClick={isFolder ? handleCardClick : undefined}
role={isFolder ? 'button' : undefined}
tabIndex={isFolder ? 0 : undefined}
title={isFolder ? asset.name : undefined}
onKeyDown={
isFolder
? (e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
handleCardClick(e as unknown as React.MouseEvent)
}
}
: undefined
}
>
{/* Left Column: Preview Only (NO LABELS, NO BADGES) */}
<div className="file-row-preview">
{thumbUrl && !isFolder && !imgError ? (
<img
src={thumbUrl}
alt={asset.name}
className="file-row-img"
onError={() => setImgError(true)}
/>
) : (
cardFallback
)}
</div>
{/* Right Column: Title, Creator & Date, Duration / Size / Comments as Raw Text */}
<div className="file-row-content">
<div className="file-row-header">
<span className="file-row-title" title={isFolder ? asset.name : undefined}>
{asset.name}
</span>
</div>
{(creatorName || timeText) && (
<div className="file-row-meta">
{creatorName && <span className="file-row-creator">{creatorName}</span>}
{creatorName && timeText && <span className="file-row-meta-dot">•</span>}
{timeText && <span className="file-row-time">{timeText}</span>}
</div>
)}
{details.length > 0 && (
<div className="file-row-subtext file-row-details">
{details.map((item, idx) => (
<React.Fragment key={idx}>
{idx > 0 && <span className="file-row-meta-dot">•</span>}
<span
className={`file-row-detail-item${item === versionLabel ? ' file-row-version' : ''}`}
>
{item}
</span>
</React.Fragment>
))}
</div>
)}
</div>
{/* Far Right Action Column (Centered Vertically across the card) */}
<div className="file-row-actions" style={{ display: 'flex', alignItems: 'center' }}>
{isFolder ? (
<sp-icon-chevron-right size="xs" className="file-row-chevron"></sp-icon-chevron-right>
) : (
<>
{(onLinkSequence || onUnlinkSequence) &&
(category === 'video' || category === 'audio') && (
<sp-action-button
quiet
size="xs"
icon-only
label={
isLinked
? onUnlinkSequence
? `Unlink from ${linkedSequenceName || 'Sequence'}`
: `Linked to ${linkedSequenceName || 'Sequence'}`
: 'Link to Sequence'
}
title={
isLinked
? onUnlinkSequence
? `Unlink from ${linkedSequenceName || 'Sequence'}`
: `Linked to ${linkedSequenceName || 'Sequence'}`
: 'Link to Sequence'
}
className="file-row-link-btn"
style={{ marginRight: 4 }}
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
if (isLinked && onUnlinkSequence) {
onUnlinkSequence(asset)
} else if (onLinkSequence) {
onLinkSequence(asset)
}
}}
>
{isLinked ? (
<sp-icon-unlink
size="s"
slot="icon"
style={{ color: '#f87171' }}
></sp-icon-unlink>
) : (
<sp-icon-link size="s" slot="icon"></sp-icon-link>
)}
</sp-action-button>
)}
{(onImportRaw || onSelectVideoForImport) && (
<sp-action-button
quiet
size="xs"
icon-only
label="Import into Premiere Pro"
title="Import into Premiere Pro"
className="file-row-import-btn"
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
handleImportAction()
}}
>
<sp-icon-download size="s" slot="icon"></sp-icon-download>
</sp-action-button>
)}
</>
)}
</div>
</div>
)
}
@@ -0,0 +1,59 @@
import React from 'react'
import { Divider } from '@swc-react/divider'
import { ShumaiLogo } from './icons'
interface HeaderProps {
endpoint?: string
onDisconnect?: () => void
}
export const Header: React.FC<HeaderProps> = ({ endpoint, onDisconnect }) => {
let displayHost = ''
if (endpoint) {
try {
const url = new URL(endpoint)
displayHost = url.host
} catch {
displayHost = endpoint
}
}
return (
<>
<header className="app-header">
<div className="logo-group">
<div className="logo-icon">
<ShumaiLogo width={18} height={18} />
</div>
<span className="app-title">Shumai</span>
</div>
{endpoint && onDisconnect && (
<div className="actions-group">
<div
className="header-status"
title={`Connected to ${endpoint}`}
role="status"
aria-label={`Connected to ${displayHost}`}
>
<span className="status-dot positive" />
<span className="status-text">{displayHost}</span>
</div>
<sp-button
quiet
variant="secondary"
size="s"
label="Disconnect / Change Server"
icon-only
onClick={onDisconnect}
title="Disconnect / Change Server"
>
<sp-icon-log-out slot="icon" size="s"></sp-icon-log-out>
</sp-button>
</div>
)}
</header>
<Divider size="s" />
</>
)
}
@@ -0,0 +1,162 @@
// @vitest-environment happy-dom
import React, { act } from 'react'
import { describe, it, expect, vi, afterEach } from 'vitest'
import { render, screen, fireEvent, cleanup } from '@testing-library/react'
import { ImportVideoDialog } from './ImportVideoDialog'
import type { AssetSummary } from './FileItem'
import * as importService from '../services/import'
// Configure React 19 act environment for happy-dom
;(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true
describe('ImportVideoDialog Component', () => {
const mockOnClose = vi.fn()
const mockOnImportRaw = vi.fn()
const mockOnImportProxy = vi.fn()
const videoAsset: AssetSummary = {
id: 'asset-vid-1',
name: 'interview_clip.mp4',
type: 'file',
mimeType: 'video/mp4',
sizeByte: 1024 * 1024 * 45,
preview: {
duration: 154,
},
}
afterEach(() => {
cleanup()
vi.clearAllMocks()
})
it('renders nothing when closed or asset is null', () => {
const { container } = render(
<ImportVideoDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={false}
onClose={mockOnClose}
onImportRaw={mockOnImportRaw}
onImportProxy={mockOnImportProxy}
/>,
)
expect(container.firstChild).toBeNull()
const { container: containerNull } = render(
<ImportVideoDialog
asset={null}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onImportRaw={mockOnImportRaw}
onImportProxy={mockOnImportProxy}
/>,
)
expect(containerNull.firstChild).toBeNull()
})
it('renders video info and selects original file by default', async () => {
vi.spyOn(importService, 'fetchVideoProxies').mockResolvedValue([])
await act(async () => {
render(
<ImportVideoDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onImportRaw={mockOnImportRaw}
onImportProxy={mockOnImportProxy}
/>,
)
})
expect(screen.getByText('Import Video')).toBeTruthy()
expect(screen.getByText('interview_clip.mp4')).toBeTruthy()
expect(screen.getByText('Original File')).toBeTruthy()
expect(screen.getByText('No proxy transcodes available for this video.')).toBeTruthy()
// Click Import button
const importBtn = screen.getByText('Import')
fireEvent.click(importBtn)
expect(mockOnImportRaw).toHaveBeenCalledWith(videoAsset)
expect(mockOnClose).toHaveBeenCalled()
})
it('fetches and allows selecting a proxy transcode', async () => {
vi.spyOn(importService, 'fetchVideoProxies').mockResolvedValue([
{
id: 'proxy-1',
label: '1080p (MP4)',
resolution: '1080p',
url: 'https://cdn.shumai.test/1080p.mp4',
key: 'proxies/1080p.mp4',
width: 1920,
height: 1080,
size: 1024 * 1024 * 12,
},
])
await act(async () => {
render(
<ImportVideoDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onImportRaw={mockOnImportRaw}
onImportProxy={mockOnImportProxy}
/>,
)
})
expect(screen.getByText('1080p (MP4)')).toBeTruthy()
// Select the proxy card
const proxyCard = screen.getByText('1080p (MP4)')
fireEvent.click(proxyCard)
// Click Import button
const importBtn = screen.getByText('Import')
fireEvent.click(importBtn)
expect(mockOnImportProxy).toHaveBeenCalledWith(
videoAsset,
expect.objectContaining({ id: 'proxy-1', label: '1080p (MP4)' }),
)
expect(mockOnClose).toHaveBeenCalled()
})
it('closes on Escape key or cancel button', async () => {
vi.spyOn(importService, 'fetchVideoProxies').mockResolvedValue([])
await act(async () => {
render(
<ImportVideoDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onImportRaw={mockOnImportRaw}
onImportProxy={mockOnImportProxy}
/>,
)
})
const cancelBtn = screen.getByText('Cancel')
fireEvent.click(cancelBtn)
expect(mockOnClose).toHaveBeenCalledTimes(1)
act(() => {
fireEvent.keyDown(document, { key: 'Escape' })
})
expect(mockOnClose).toHaveBeenCalledTimes(2)
})
})
@@ -0,0 +1,245 @@
import React, { useState, useEffect, useCallback } from 'react'
import type { AssetSummary } from './FileItem'
import { fetchVideoProxies, type ProxyOption } from '../services/import'
import { formatBytes, formatDuration } from '../utils/format'
import { resolveAssetUrl } from '../utils/url'
import { ProgressCircle } from '@swc-react/progress-circle'
export interface ImportVideoDialogProps {
asset: AssetSummary | null
endpoint: string
apiKey: string
isOpen: boolean
onClose: () => void
onImportRaw: (asset: AssetSummary) => void
onImportProxy: (asset: AssetSummary, proxy: ProxyOption) => void
}
export const ImportVideoDialog: React.FC<ImportVideoDialogProps> = ({
asset,
endpoint,
apiKey,
isOpen,
onClose,
onImportRaw,
onImportProxy,
}) => {
const [selectedVersion, setSelectedVersion] = useState<'raw' | string>('raw')
const [proxies, setProxies] = useState<ProxyOption[]>([])
const [loadingProxies, setLoadingProxies] = useState(false)
const [thumbError, setThumbError] = useState(false)
// Reset and fetch proxies when a new video asset is opened
useEffect(() => {
if (!isOpen || !asset) {
setProxies([])
setSelectedVersion('raw')
setLoadingProxies(false)
setThumbError(false)
return
}
let isMounted = true
setLoadingProxies(true)
setSelectedVersion('raw')
void fetchVideoProxies(endpoint, apiKey, asset.id)
.then((items) => {
if (isMounted) {
setProxies(items)
}
})
.catch((err) => {
console.warn('Failed to load video proxies:', err)
})
.finally(() => {
if (isMounted) {
setLoadingProxies(false)
}
})
return () => {
isMounted = false
}
}, [isOpen, asset, endpoint, apiKey])
// Handle Escape key to close dialog
useEffect(() => {
if (!isOpen) return
const handleKeyDown = (e: KeyboardEvent) => {
if (e.key === 'Escape') {
onClose()
}
}
document.addEventListener('keydown', handleKeyDown)
return () => {
document.removeEventListener('keydown', handleKeyDown)
}
}, [isOpen, onClose])
const handleConfirm = useCallback(() => {
if (!asset) return
if (selectedVersion === 'raw') {
onClose()
onImportRaw(asset)
} else if (selectedVersion.startsWith('proxy:')) {
const proxyId = selectedVersion.slice('proxy:'.length)
const targetProxy = proxies.find((p) => p.id === proxyId)
if (targetProxy) {
onClose()
onImportProxy(asset, targetProxy)
}
}
}, [asset, selectedVersion, proxies, onClose, onImportRaw, onImportProxy])
if (!isOpen || !asset) return null
const effectiveSize = asset.sizeByte ?? asset.size
const thumbUrl = resolveAssetUrl(asset.preview?.thumbnailUrl, endpoint)
const duration = asset.preview?.duration ?? asset.media?.metadata?.duration
const durationText = formatDuration(duration)
return (
<div
className="shumai-dialog-backdrop"
onClick={(e) => {
if (e.target === e.currentTarget) {
onClose()
}
}}
>
<div className="shumai-dialog" role="dialog" aria-modal="true" aria-labelledby="dialog-title">
{/* Dialog Header */}
<div className="shumai-dialog-header">
<span id="dialog-title" className="shumai-dialog-title">
Import Video
</span>
<button
type="button"
className="shumai-dialog-close"
onClick={onClose}
title="Close dialog"
aria-label="Close dialog"
>
<sp-icon-close size="s"></sp-icon-close>
</button>
</div>
{/* Video Asset Preview Info */}
<div className="shumai-dialog-asset-info">
<div className="shumai-dialog-thumb">
{thumbUrl && !thumbError ? (
<img src={thumbUrl} alt={asset.name} onError={() => setThumbError(true)} />
) : (
<sp-icon-filmstrip size="xxl" style={{ color: '#60a5fa' }}></sp-icon-filmstrip>
)}
</div>
<div className="shumai-dialog-asset-meta">
<span className="shumai-dialog-asset-name" title={asset.name}>
{asset.name}
</span>
<span className="shumai-dialog-asset-details">
{durationText ? `${durationText} • ` : ''}
{effectiveSize ? formatBytes(effectiveSize) : 'Video'}
</span>
</div>
</div>
{/* Options Selection Body */}
<div className="shumai-dialog-body">
<div className="shumai-dialog-section-label">Choose Version to Import</div>
{/* Original Version Card */}
<div
className={`shumai-option-card ${selectedVersion === 'raw' ? 'selected' : ''}`}
onClick={() => setSelectedVersion('raw')}
role="radio"
aria-checked={selectedVersion === 'raw'}
tabIndex={0}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
setSelectedVersion('raw')
}
}}
>
<div className="shumai-option-left">
<div className="shumai-option-texts">
<span className="shumai-option-title">Original File</span>
<span className="shumai-option-meta">
Full resolution • {effectiveSize ? formatBytes(effectiveSize) : 'Raw file'}
</span>
</div>
</div>
<div className="shumai-option-radio">
{selectedVersion === 'raw' && <div className="shumai-option-radio-dot" />}
</div>
</div>
<div className="shumai-dialog-divider" />
{/* Proxies Section */}
<div className="shumai-dialog-section-label">Transcode Proxies</div>
{loadingProxies ? (
<div className="shumai-dialog-loading">
<ProgressCircle indeterminate size="s" label="Checking available proxies..." />
<span>Checking available proxies...</span>
</div>
) : proxies.length > 0 ? (
proxies.map((proxy) => {
const isSelected = selectedVersion === `proxy:${proxy.id}`
return (
<div
key={proxy.id}
className={`shumai-option-card ${isSelected ? 'selected' : ''}`}
onClick={() => setSelectedVersion(`proxy:${proxy.id}`)}
role="radio"
aria-checked={isSelected}
tabIndex={0}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
setSelectedVersion(`proxy:${proxy.id}`)
}
}}
>
<div className="shumai-option-left">
<div className="shumai-option-texts">
<span className="shumai-option-title">{proxy.label}</span>
<span className="shumai-option-meta">
{proxy.width && proxy.height ? `${proxy.width}x${proxy.height} • ` : ''}
{proxy.size ? `${formatBytes(proxy.size)} • ` : ''}
Fast editing proxy
</span>
</div>
</div>
<div className="shumai-option-radio">
{isSelected && <div className="shumai-option-radio-dot" />}
</div>
</div>
)
})
) : (
<div className="shumai-dialog-empty-proxies">
<span>No proxy transcodes available for this video.</span>
</div>
)}
</div>
{/* Dialog Footer Actions */}
<div className="shumai-dialog-footer">
<sp-button quiet variant="secondary" size="s" onClick={onClose}>
Cancel
</sp-button>
<sp-button variant="accent" size="s" onClick={handleConfirm}>
Import
</sp-button>
</div>
</div>
</div>
)
}
@@ -0,0 +1,194 @@
// @vitest-environment happy-dom
import React, { act } from 'react'
import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest'
import { render, screen, fireEvent, cleanup } from '@testing-library/react'
import { LinkSequenceDialog } from './LinkSequenceDialog'
import type { AssetSummary } from './FileItem'
import * as premiereService from '../services/premiere'
import * as linkStorage from '../services/linkStorage'
import * as markersService from '../services/markers'
import type { Project, Sequence } from '@adobe/premierepro'
import type { CommentInfo } from '@shumai/dtos'
// Configure React 19 act environment for happy-dom
;(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true
describe('LinkSequenceDialog Component', () => {
const mockOnClose = vi.fn()
const mockOnLinkSuccess = vi.fn()
const videoAsset: AssetSummary = {
id: 'asset-vid-1',
name: 'interview_clip.mp4',
type: 'file',
mimeType: 'video/mp4',
sizeByte: 1024 * 1024 * 45,
preview: {
duration: 154,
},
commentsCount: 3,
}
beforeEach(() => {
vi.restoreAllMocks()
})
afterEach(() => {
cleanup()
})
it('renders nothing when closed or asset is null', () => {
const { container } = render(
<LinkSequenceDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={false}
onClose={mockOnClose}
onLinkSuccess={mockOnLinkSuccess}
/>,
)
expect(container.firstChild).toBeNull()
const { container: containerNull } = render(
<LinkSequenceDialog
asset={null}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onLinkSuccess={mockOnLinkSuccess}
/>,
)
expect(containerNull.firstChild).toBeNull()
})
it('displays error message when no active project is open', async () => {
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(null)
await act(async () => {
render(
<LinkSequenceDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onLinkSuccess={mockOnLinkSuccess}
/>,
)
})
expect(screen.getByText(/no active premiere pro project found/i)).toBeDefined()
})
it('lists project sequences and highlights active sequence without sequence icon', async () => {
const mockSeq1 = { guid: 'seq-1', name: 'Rough Cut' }
const mockSeq2 = { guid: 'seq-2', name: 'Fine Cut' }
const mockProject = { guid: 'proj-1' }
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([
mockSeq1,
mockSeq2,
] as unknown as Sequence[])
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(
mockSeq2 as unknown as Sequence,
)
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([])
let renderedContainer: HTMLElement = null!
await act(async () => {
const { container } = render(
<LinkSequenceDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onLinkSuccess={mockOnLinkSuccess}
/>,
)
renderedContainer = container
})
expect(screen.getByText('Rough Cut')).toBeDefined()
expect(screen.getByText('Fine Cut')).toBeDefined()
expect(screen.getByText('Active')).toBeDefined()
expect(renderedContainer.querySelectorAll('.shumai-option-card sp-icon-filmstrip').length).toBe(
0,
)
})
it('executes sync and invokes onLinkSuccess on confirmation', async () => {
const mockSeq1 = { guid: 'seq-1', name: 'Rough Cut' }
const mockProject = { guid: 'proj-1' }
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([
mockSeq1,
] as unknown as Sequence[])
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(
mockSeq1 as unknown as Sequence,
)
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([])
vi.spyOn(markersService, 'fetchAssetComments').mockResolvedValue([
{ id: 'comm-1', second: 10, message: 'Test marker' } as unknown as CommentInfo,
])
const mockUpdatedLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Rough Cut',
assetId: 'asset-vid-1',
assetName: 'interview_clip.mp4',
syncedCommentIds: ['comm-1'],
lastSyncAt: Date.now(),
totalCommentsSynced: 1,
}
vi.spyOn(markersService, 'syncCommentsToSequence').mockResolvedValue({
updatedLink: mockUpdatedLink,
addedCount: 1,
})
await act(async () => {
render(
<LinkSequenceDialog
asset={videoAsset}
endpoint="https://api.shumai.test"
apiKey="test-key"
isOpen={true}
onClose={mockOnClose}
onLinkSuccess={mockOnLinkSuccess}
/>,
)
})
const linkBtn = screen.getByText('Link Sequence')
await act(async () => {
fireEvent.click(linkBtn)
})
expect(markersService.fetchAssetComments).toHaveBeenCalledWith(
'https://api.shumai.test',
'test-key',
'asset-vid-1',
)
expect(markersService.syncCommentsToSequence).toHaveBeenCalledWith(
mockProject,
mockSeq1,
expect.any(Array),
expect.objectContaining({
endpoint: 'https://api.shumai.test',
sequenceGuid: 'seq-1',
assetId: 'asset-vid-1',
}),
)
expect(mockOnLinkSuccess).toHaveBeenCalledWith(mockUpdatedLink, 1)
expect(mockOnClose).toHaveBeenCalled()
})
})
@@ -0,0 +1,420 @@
import React, { useState, useEffect, useCallback } from 'react'
import type { Sequence, Project } from '@adobe/premierepro'
import type { AssetSummary } from './FileItem'
import type { LinkedSequenceAsset } from '../types/link'
import { getActiveProject, getAllSequences, getActiveSequence } from '../services/premiere'
import { getAllLinkedSequences, normalizeGuid, removeSequenceLink } from '../services/linkStorage'
import { fetchAssetComments, syncCommentsToSequence } from '../services/markers'
import { resolveAssetUrl, isSameEndpoint } from '../utils/url'
import { formatBytes, formatDuration } from '../utils/format'
import { ProgressCircle } from '@swc-react/progress-circle'
export interface LinkSequenceDialogProps {
asset: AssetSummary | null
endpoint: string
apiKey: string
isOpen: boolean
onClose: () => void
onLinkSuccess: (link: LinkedSequenceAsset, addedMarkersCount: number) => void
}
interface SequenceOption {
sequence: Sequence
guid: string
name: string
isActive: boolean
currentLink: LinkedSequenceAsset | null
}
export const LinkSequenceDialog: React.FC<LinkSequenceDialogProps> = ({
asset,
endpoint,
apiKey,
isOpen,
onClose,
onLinkSuccess,
}) => {
const [project, setProject] = useState<Project | null>(null)
const [sequences, setSequences] = useState<SequenceOption[]>([])
const [selectedGuid, setSelectedGuid] = useState<string>('')
const [loadingSequences, setLoadingSequences] = useState(true)
const [linking, setLinking] = useState(false)
const [errorMessage, setErrorMessage] = useState<string | null>(null)
const [thumbError, setThumbError] = useState(false)
// Load project sequences and link states when opened
useEffect(() => {
if (!isOpen || !asset) {
setProject(null)
setSequences([])
setSelectedGuid('')
setErrorMessage(null)
setLinking(false)
setThumbError(false)
return
}
let isMounted = true
setLoadingSequences(true)
setErrorMessage(null)
async function loadProjectData() {
try {
const pr = await getActiveProject()
if (!isMounted) return
if (!pr) {
setProject(null)
setLoadingSequences(false)
setErrorMessage('No active Premiere Pro project found. Please open a project first.')
return
}
setProject(pr)
const [allSeqs, activeSeq, existingLinks] = await Promise.all([
getAllSequences(pr),
getActiveSequence(pr),
getAllLinkedSequences(pr),
])
if (!isMounted) return
if (!allSeqs || allSeqs.length === 0) {
setLoadingSequences(false)
setErrorMessage(
'No sequences found in the current project. Please create a sequence first.',
)
return
}
const activeGuid = normalizeGuid(activeSeq?.guid)
const linksMap = new Map<string, LinkedSequenceAsset>()
for (const link of existingLinks) {
if (!link.endpoint || isSameEndpoint(link.endpoint, endpoint)) {
linksMap.set(normalizeGuid(link.sequenceGuid), link)
}
}
const options: SequenceOption[] = allSeqs.map((seq) => {
const guidStr = normalizeGuid(seq.guid)
return {
sequence: seq,
guid: guidStr,
name: seq.name || 'Untitled Sequence',
isActive: Boolean(activeGuid && guidStr === activeGuid),
currentLink: linksMap.get(guidStr) || null,
}
})
setSequences(options)
// Pre-select active sequence if found, else first sequence
if (activeGuid && options.some((opt) => opt.guid === activeGuid)) {
setSelectedGuid(activeGuid)
} else if (options.length > 0) {
setSelectedGuid(options[0].guid)
}
} catch (err) {
if (!isMounted) return
console.error('[LinkSequenceDialog] Error loading project data:', err)
setErrorMessage('Failed to load project sequences from Premiere Pro.')
} finally {
if (isMounted) {
setLoadingSequences(false)
}
}
}
void loadProjectData()
return () => {
isMounted = false
}
}, [isOpen, asset, endpoint])
// Escape key handler
useEffect(() => {
if (!isOpen) return
const handleKeyDown = (e: KeyboardEvent) => {
if (e.key === 'Escape' && !linking) {
onClose()
}
}
document.addEventListener('keydown', handleKeyDown)
return () => {
document.removeEventListener('keydown', handleKeyDown)
}
}, [isOpen, linking, onClose])
const handleConfirm = useCallback(async () => {
if (!asset || !project || !selectedGuid || linking) return
const targetOption = sequences.find(
(opt) => normalizeGuid(opt.guid) === normalizeGuid(selectedGuid),
)
if (!targetOption) return
setLinking(true)
try {
// If sequence was linked to another asset, remove its previous link and markers first
if (targetOption.currentLink && targetOption.currentLink.assetId !== asset.id) {
await removeSequenceLink(project, targetOption.sequence)
}
// 1. Fetch timecoded comments for this asset
const comments = await fetchAssetComments(endpoint, apiKey, asset.id)
// 2. Prepare initial link metadata
const prGuidStr = project.guid ? normalizeGuid(project.guid) : undefined
const initialLink: LinkedSequenceAsset = {
sequenceGuid: normalizeGuid(targetOption.guid),
sequenceName: targetOption.name,
assetId: asset.id,
assetName: asset.name,
assetThumbnailUrl: asset.preview?.thumbnailUrl,
endpoint: endpoint.trim().replace(/\/+$/, ''),
projectId: prGuidStr,
syncedCommentIds:
targetOption.currentLink?.assetId === asset.id
? targetOption.currentLink.syncedCommentIds
: [],
syncedMarkerGuids:
targetOption.currentLink?.assetId === asset.id
? (targetOption.currentLink.syncedMarkerGuids || []).map(normalizeGuid)
: [],
lastSyncAt: Date.now(),
totalCommentsSynced:
targetOption.currentLink?.assetId === asset.id
? targetOption.currentLink.totalCommentsSynced
: 0,
}
// 3. Translate comments to markers on the sequence
const { updatedLink, addedCount } = await syncCommentsToSequence(
project,
targetOption.sequence,
comments,
initialLink,
)
onLinkSuccess(updatedLink, addedCount)
onClose()
} catch (err) {
console.error('[LinkSequenceDialog] Failed to link sequence:', err)
setErrorMessage('Failed to link sequence and sync markers. Please try again.')
} finally {
setLinking(false)
}
}, [asset, project, selectedGuid, linking, sequences, endpoint, apiKey, onLinkSuccess, onClose])
if (!isOpen || !asset) return null
const selectedOption = sequences.find((opt) => opt.guid === selectedGuid)
const isReplacingOtherAsset =
selectedOption?.currentLink && selectedOption.currentLink.assetId !== asset.id
const effectiveSize = asset.sizeByte ?? asset.size
const thumbUrl = resolveAssetUrl(asset.preview?.thumbnailUrl, endpoint)
const duration = asset.preview?.duration ?? asset.media?.metadata?.duration
const durationText = formatDuration(duration)
return (
<div
className="shumai-dialog-backdrop"
onClick={(e) => {
if (e.target === e.currentTarget && !linking) {
onClose()
}
}}
>
<div
className="shumai-dialog"
role="dialog"
aria-modal="true"
aria-labelledby="link-dialog-title"
>
{/* Header */}
<div className="shumai-dialog-header">
<div style={{ display: 'flex', alignItems: 'center' }}>
<sp-icon-link size="s" style={{ marginRight: 6, color: '#3b82f6' }}></sp-icon-link>
<span id="link-dialog-title" className="shumai-dialog-title">
Link to Sequence
</span>
</div>
<button
type="button"
className="shumai-dialog-close"
onClick={onClose}
disabled={linking}
title="Close dialog"
aria-label="Close dialog"
>
<sp-icon-close size="s"></sp-icon-close>
</button>
</div>
{/* Asset Info Card */}
<div className="shumai-dialog-asset-info">
<div className="shumai-dialog-thumb">
{thumbUrl && !thumbError ? (
<img src={thumbUrl} alt={asset.name} onError={() => setThumbError(true)} />
) : asset.type === 'video' ? (
<sp-icon-filmstrip size="xxl" style={{ color: '#60a5fa' }}></sp-icon-filmstrip>
) : asset.type === 'audio' ? (
<sp-icon-audio size="xxl" style={{ color: '#a78bfa' }}></sp-icon-audio>
) : (
<sp-icon-document size="xxl" style={{ color: '#999999' }}></sp-icon-document>
)}
</div>
<div className="shumai-dialog-asset-meta">
<span className="shumai-dialog-asset-name" title={asset.name}>
{asset.name}
</span>
<span className="shumai-dialog-asset-details">
{durationText ? `${durationText} • ` : ''}
{effectiveSize ? `${formatBytes(effectiveSize)} • ` : ''}
{asset.commentsCount != null && asset.commentsCount > 0
? `${asset.commentsCount} comments`
: 'No comments'}
</span>
</div>
</div>
{/* Dialog Body */}
<div className="shumai-dialog-body">
<div className="shumai-dialog-section-label">Select Sequence in Project</div>
{loadingSequences ? (
<div className="shumai-dialog-loading">
<ProgressCircle indeterminate size="s" label="Checking project sequences..." />
<span>Checking project sequences...</span>
</div>
) : errorMessage ? (
<div className="shumai-dialog-empty-proxies" style={{ color: '#f87171' }}>
<span>{errorMessage}</span>
</div>
) : sequences.length > 0 ? (
sequences.map((opt) => {
const isSelected = selectedGuid === opt.guid
const isLinkedToAnother = opt.currentLink && opt.currentLink.assetId !== asset.id
const isLinkedToThis = opt.currentLink && opt.currentLink.assetId === asset.id
return (
<div
key={opt.guid}
className={`shumai-option-card ${isSelected ? 'selected' : ''}`}
onClick={() => !linking && setSelectedGuid(opt.guid)}
role="radio"
aria-checked={isSelected}
tabIndex={0}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
if (!linking) setSelectedGuid(opt.guid)
}
}}
>
<div className="shumai-option-left">
<div className="shumai-option-texts">
<div style={{ display: 'flex', alignItems: 'center' }}>
<span className="shumai-option-title">{opt.name}</span>
{opt.isActive && (
<span
style={{
fontSize: '10px',
marginLeft: 6,
padding: '1px 5px',
borderRadius: '3px',
backgroundColor: 'rgba(59, 130, 246, 0.2)',
color: '#60a5fa',
fontWeight: 500,
}}
>
Active
</span>
)}
</div>
<span className="shumai-option-meta">
{isLinkedToThis ? (
<span style={{ color: '#34d399' }}>Already linked to this asset</span>
) : isLinkedToAnother ? (
<span style={{ color: '#fbbf24' }}>
Linked to &quot;{opt.currentLink?.assetName}&quot; (will replace)
</span>
) : (
'Ready to link'
)}
</span>
</div>
</div>
<div className="shumai-option-radio">
{isSelected && <div className="shumai-option-radio-dot" />}
</div>
</div>
)
})
) : (
<div className="shumai-dialog-empty-proxies">
<span>No sequences available in current project.</span>
</div>
)}
{isReplacingOtherAsset && (
<div
style={{
marginTop: 10,
padding: '8px 10px',
borderRadius: 4,
backgroundColor: 'rgba(245, 158, 11, 0.12)',
border: '1px solid rgba(245, 158, 11, 0.3)',
display: 'flex',
alignItems: 'center',
fontSize: 11,
color: '#fbbf24',
}}
>
<sp-icon-alert-triangle
size="s"
style={{ marginRight: 6, flexShrink: 0 }}
></sp-icon-alert-triangle>
<span>
This sequence is already linked to another asset. Proceeding will replace the link
and sync markers for this asset.
</span>
</div>
)}
<div style={{ marginTop: 12, fontSize: 11, color: 'var(--text-secondary)' }}>
Comments with timestamps will be placed on the sequence timeline as markers. Markers
deleted in Premiere Pro will not be re-synced.
</div>
</div>
{/* Footer */}
<div className="shumai-dialog-footer">
<sp-button quiet variant="secondary" size="s" onClick={onClose} disabled={linking}>
Cancel
</sp-button>
<sp-button
variant="accent"
size="s"
onClick={handleConfirm}
disabled={!selectedGuid || loadingSequences || Boolean(errorMessage) || linking}
>
{linking ? (
<>
<ProgressCircle indeterminate size="s" slot="icon" label="Linking..." />
Linking...
</>
) : isReplacingOtherAsset ? (
'Replace & Link'
) : (
'Link Sequence'
)}
</sp-button>
</div>
</div>
</div>
)
}
@@ -0,0 +1,33 @@
// @vitest-environment happy-dom
import React from 'react'
import { describe, it, expect, vi, afterEach } from 'vitest'
import { render, screen, fireEvent, cleanup } from '@testing-library/react'
import { NavigationTabs } from './NavigationTabs'
describe('NavigationTabs Component', () => {
afterEach(() => {
cleanup()
})
it('renders Sequences and Browse tabs with badge', () => {
const handleTabChange = vi.fn()
render(<NavigationTabs activeTab="sequences" onTabChange={handleTabChange} linkedCount={3} />)
expect(screen.getByText('Sequences')).toBeDefined()
expect(screen.getByText('Browse')).toBeDefined()
expect(screen.getByText('3')).toBeDefined()
})
it('handles tab click events', () => {
const handleTabChange = vi.fn()
render(<NavigationTabs activeTab="sequences" onTabChange={handleTabChange} linkedCount={0} />)
const browseTab = screen.getByText('Browse')
fireEvent.click(browseTab)
expect(handleTabChange).toHaveBeenCalledWith('browse')
const sequencesTab = screen.getByText('Sequences')
fireEvent.click(sequencesTab)
expect(handleTabChange).toHaveBeenCalledWith('sequences')
})
})
@@ -0,0 +1,44 @@
import React from 'react'
export type MainTab = 'sequences' | 'browse'
export interface NavigationTabsProps {
activeTab: MainTab
onTabChange: (tab: MainTab) => void
linkedCount?: number
}
export const NavigationTabs: React.FC<NavigationTabsProps> = ({
activeTab,
onTabChange,
linkedCount = 0,
}) => {
return (
<div className="shumai-nav-tabs-bar" role="tablist">
<sp-button
size="s"
variant={activeTab === 'sequences' ? 'accent' : 'secondary'}
treatment="fill"
onClick={() => onTabChange('sequences')}
className={`shumai-tab-sp-btn ${activeTab === 'sequences' ? 'active' : ''}`}
>
<span className="shumai-tab-label">Sequences</span>
{linkedCount > 0 && (
<span className="shumai-tab-badge" title={`${linkedCount} linked sequence assets`}>
{linkedCount}
</span>
)}
</sp-button>
<sp-button
size="s"
variant={activeTab === 'browse' ? 'accent' : 'secondary'}
treatment="fill"
onClick={() => onTabChange('browse')}
className={`shumai-tab-sp-btn ${activeTab === 'browse' ? 'active' : ''}`}
>
<span className="shumai-tab-label">Browse</span>
</sp-button>
</div>
)
}
@@ -0,0 +1,88 @@
import React, { useState } from 'react'
import { formatDateAgo } from '../utils/date'
import { resolveAssetUrl } from '../utils/url'
import type { ProjectSummary } from '../views/ProjectsView'
interface ProjectCardProps {
project: ProjectSummary
endpoint?: string
onClick: () => void
}
export const ShumaiPolygonCover: React.FC = () => (
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 180.95 164.7"
preserveAspectRatio="xMidYMid slice"
style={{ width: '100%', height: '100%', display: 'block' }}
>
<polygon fill="#FC9F8E" points="0 18.5 0 76.0 151.69 164.7 180.95 164.7 180.95 113.6" />
<polygon fill="#FEBAB8" points="0 0 74.58 61.5 90.53 51.6 110.33 63.9 180.95 18.9 180.95 0" />
<polyline
fill="#FAA5A5"
points="0 18.5 74.58 61.5 90.53 51.6 110.33 63.9 180.95 18.9 180.95 0 0 0"
/>
<polygon fill="#EC5B6C" points="0 76.0 0 164.7 151.69 164.7" />
<polygon fill="#E85C71" points="180.95 18.9 110.33 63.9 117.37 68.0 117.26 73.4 180.95 113.6" />
<polygon
fill="#C8405B"
points="117.26 73.4 117.37 99.0 90.53 114.9 174.35 164.7 180.95 164.7 180.95 113.6"
/>
<polygon fill="#FFCCBE" points="90.53 51.6 63.69 68.1 90.53 83.4" />
<path
fill="#FB9991"
d="M 90.53 51.6 L 90.53 61.3 L 100.87 67.4 L 90.53 73.5 L 90.53 83.4 L 117.37 68.0 C 117.15 67.6 90.53 51.6 90.53 51.6 Z"
/>
<path
fill="#FFEACD"
d="M 63.69 68.1 C 63.47 68.5 64.02 99.3 64.02 99.3 C 64.02 99.3 64.46 99.6 64.9 99.9 L 90.53 83.4 L 63.69 68.1 Z"
/>
<polygon fill="#FFCFB5" points="64.02 99.3 90.53 114.9 90.53 83.4" />
<path fill="#F67D73" d="M 90.53 83.4 L 90.53 114.9 L 117.37 99.0 Z" />
<path fill="#F26560" d="M 90.53 83.4 L 117.37 99.0 L 117.37 68.0 Z" />
<polygon fill="#EB5F5B" points="80.08 67.5 90.53 73.5 90.53 61.3" />
<polygon fill="#DB4D50" points="90.53 61.3 90.53 73.5 100.87 67.4" />
</svg>
)
export const ProjectCard: React.FC<ProjectCardProps> = ({ project, endpoint, onClick }) => {
const [imgError, setImgError] = useState(false)
const updatedText = formatDateAgo(project.updatedAt)
const coverUrl = resolveAssetUrl(project.coverImage, endpoint)
return (
<div
className="project-row-card"
onClick={onClick}
role="button"
tabIndex={0}
title={project.name}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
onClick()
}
}}
>
<div className="project-row-preview">
{coverUrl && !imgError ? (
<img
src={coverUrl}
alt={project.name}
className="project-row-img"
onError={() => setImgError(true)}
/>
) : (
<ShumaiPolygonCover />
)}
</div>
<div className="project-row-content">
<span className="project-row-title">{project.name}</span>
<span className="project-row-subtext">
{updatedText ? `Updated ${updatedText}` : 'Project'}
</span>
</div>
</div>
)
}
@@ -0,0 +1,41 @@
import React from 'react'
export const ShumaiLogo: React.FC<React.SVGProps<SVGSVGElement>> = (props) => {
return (
<svg viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg" {...props}>
<defs>
<clipPath id="bg-clip">
<rect x="5" y="5" width="90" height="90" rx="22" />
</clipPath>
</defs>
{/* Background */}
<rect x="5" y="5" width="90" height="90" rx="22" fill="#D95A66" />
{/* Long Shadow */}
<path
d="M 35 75 L 65 75 L 80 60 L 75 30 L 175 130 L 135 175 Z"
fill="#A8384D"
clipPath="url(#bg-clip)"
/>
{/* Left Cream */}
<path d="M 25 30 Q 38 36 50 42 L 35 55 L 35 75 L 20 60 Z" fill="#FDF0D5" />
{/* Right Orange */}
<path d="M 50 42 Q 62 36 75 30 L 80 60 L 65 75 L 65 55 Z" fill="#E77A65" />
{/* Front Peach */}
<path d="M 35 75 L 65 75 L 65 55 L 50 42 L 35 55 Z" fill="#F5B895" />
{/* Top Pink */}
<path d="M 50 42 Q 38 36 25 30 Q 38 26 50 20 Q 62 26 75 30 Q 62 36 50 42 Z" fill="#F4B8B8" />
{/* Hole Left */}
<path d="M 50 25 L 42 30 L 50 35 Z" fill="#E57A5F" />
{/* Hole Right */}
<path d="M 50 25 L 58 30 L 50 35 Z" fill="#C2523C" />
</svg>
)
}
+299
View File
@@ -0,0 +1,299 @@
/* eslint-disable @typescript-eslint/naming-convention -- Custom element tag names in IntrinsicElements require hyphens */
declare module '@swc-uxp-wrappers/utils' {
export const aliases: Record<string, string>
}
type SpIconCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
size?: 'xxs' | 'xs' | 's' | 'm' | 'l' | 'xl' | 'xxl'
slot?: string
name?: string
label?: string
}
type SpButtonCustomElementProps = import('react').DetailedHTMLProps<
import('react').ButtonHTMLAttributes<HTMLButtonElement>,
HTMLButtonElement
> & {
variant?: 'accent' | 'primary' | 'secondary' | 'negative' | 'white' | 'black' | string
treatment?: 'fill' | 'outline' | string
quiet?: boolean
size?: 'xs' | 's' | 'm' | 'l' | 'xl'
label?: string
'icon-only'?: boolean
disabled?: boolean
slot?: string
}
type SpButtonGroupCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
vertical?: boolean
size?: 'xs' | 's' | 'm' | 'l' | 'xl'
}
type SpActionButtonCustomElementProps = import('react').DetailedHTMLProps<
import('react').ButtonHTMLAttributes<HTMLButtonElement>,
HTMLButtonElement
> & {
quiet?: boolean
size?: 'xs' | 's' | 'm' | 'l' | 'xl'
label?: string
disabled?: boolean
selected?: boolean
toggles?: boolean
emphasized?: boolean
slot?: string
}
type SpActionMenuCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
quiet?: boolean
size?: 'xs' | 's' | 'm' | 'l' | 'xl'
label?: string
disabled?: boolean
open?: boolean
placement?:
| 'top'
| 'top-start'
| 'top-end'
| 'right'
| 'right-start'
| 'right-end'
| 'bottom'
| 'bottom-start'
| 'bottom-end'
| 'left'
| 'left-start'
| 'left-end'
'force-popover'?: boolean
selects?: 'single'
value?: string
slot?: string
}
type SpMenuCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
slot?: string
selects?: 'single' | 'multiple' | 'inherit'
label?: string
}
type SpMenuItemCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
disabled?: boolean
selected?: boolean
value?: string
slot?: string
}
type SpMenuDividerCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
size?: 's' | 'm' | 'l'
}
type SpMenuGroupCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
slot?: string
}
type SpStatusLightCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
variant?:
| 'negative'
| 'notice'
| 'positive'
| 'info'
| 'neutral'
| 'yellow'
| 'fuchsia'
| 'indigo'
| 'seafoam'
| 'chartreuse'
| 'magenta'
| 'celery'
| 'purple'
| string
disabled?: boolean
slot?: string
}
type SpProgressCircleCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
size?: 's' | 'm' | 'l'
indeterminate?: boolean
label?: string
slot?: string
'static-color'?: 'white' | string
}
type SpTopNavCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
selected?: string
quiet?: boolean
compact?: boolean
label?: string
}
type SpTopNavItemCustomElementProps = import('react').DetailedHTMLProps<
import('react').HTMLAttributes<HTMLElement>,
HTMLElement
> & {
value?: string
selected?: boolean
href?: string
disabled?: boolean
}
declare namespace React {
namespace JSX {
interface IntrinsicElements {
'sp-icon': SpIconCustomElementProps
'sp-icon-refresh': SpIconCustomElementProps
'sp-icon-chevron-down': SpIconCustomElementProps
'sp-icon-chevron-right': SpIconCustomElementProps
'sp-icon-log-out': SpIconCustomElementProps
'sp-icon-arrow-right': SpIconCustomElementProps
'sp-icon-filmstrip': SpIconCustomElementProps
'sp-icon-folder': SpIconCustomElementProps
'sp-icon-folder-open': SpIconCustomElementProps
'sp-icon-audio': SpIconCustomElementProps
'sp-icon-image': SpIconCustomElementProps
'sp-icon-document': SpIconCustomElementProps
'sp-icon-link': SpIconCustomElementProps
'sp-icon-unlink': SpIconCustomElementProps
'sp-icon-link-out': SpIconCustomElementProps
'sp-icon-download': SpIconCustomElementProps
'sp-icon-briefcase': SpIconCustomElementProps
'sp-icon-alert-circle': SpIconCustomElementProps
'sp-icon-alert-triangle': SpIconCustomElementProps
'sp-icon-checkmark-circle': SpIconCustomElementProps
'sp-icon-close': SpIconCustomElementProps
'sp-icon-movie-camera': SpIconCustomElementProps
'sp-icon-video-filled': SpIconCustomElementProps
'sp-button': SpButtonCustomElementProps
'sp-button-group': SpButtonGroupCustomElementProps
'sp-action-button': SpActionButtonCustomElementProps
'sp-action-menu': SpActionMenuCustomElementProps
'sp-menu': SpMenuCustomElementProps
'sp-menu-item': SpMenuItemCustomElementProps
'sp-menu-divider': SpMenuDividerCustomElementProps
'sp-menu-group': SpMenuGroupCustomElementProps
'sp-status-light': SpStatusLightCustomElementProps
'sp-progress-circle': SpProgressCircleCustomElementProps
'sp-top-nav': SpTopNavCustomElementProps
'sp-top-nav-item': SpTopNavItemCustomElementProps
}
}
}
declare namespace JSX {
interface IntrinsicElements {
'sp-icon': SpIconCustomElementProps
'sp-icon-refresh': SpIconCustomElementProps
'sp-icon-chevron-down': SpIconCustomElementProps
'sp-icon-chevron-right': SpIconCustomElementProps
'sp-icon-log-out': SpIconCustomElementProps
'sp-icon-arrow-right': SpIconCustomElementProps
'sp-icon-filmstrip': SpIconCustomElementProps
'sp-icon-folder': SpIconCustomElementProps
'sp-icon-folder-open': SpIconCustomElementProps
'sp-icon-audio': SpIconCustomElementProps
'sp-icon-image': SpIconCustomElementProps
'sp-icon-document': SpIconCustomElementProps
'sp-icon-link': SpIconCustomElementProps
'sp-icon-unlink': SpIconCustomElementProps
'sp-icon-link-out': SpIconCustomElementProps
'sp-icon-download': SpIconCustomElementProps
'sp-icon-briefcase': SpIconCustomElementProps
'sp-icon-alert-circle': SpIconCustomElementProps
'sp-icon-alert-triangle': SpIconCustomElementProps
'sp-icon-checkmark-circle': SpIconCustomElementProps
'sp-icon-close': SpIconCustomElementProps
'sp-icon-movie-camera': SpIconCustomElementProps
'sp-icon-video-filled': SpIconCustomElementProps
'sp-button': SpButtonCustomElementProps
'sp-button-group': SpButtonGroupCustomElementProps
'sp-action-button': SpActionButtonCustomElementProps
'sp-action-menu': SpActionMenuCustomElementProps
'sp-menu': SpMenuCustomElementProps
'sp-menu-item': SpMenuItemCustomElementProps
'sp-menu-divider': SpMenuDividerCustomElementProps
'sp-menu-group': SpMenuGroupCustomElementProps
'sp-status-light': SpStatusLightCustomElementProps
'sp-progress-circle': SpProgressCircleCustomElementProps
'sp-top-nav': SpTopNavCustomElementProps
'sp-top-nav-item': SpTopNavItemCustomElementProps
}
}
type UxpEntry = UxpFileEntry | UxpFolderEntry
interface UxpFileEntry {
readonly isFile: true
readonly isFolder: false
readonly name: string
readonly nativePath: string
write(data: ArrayBuffer | string, options?: { format?: unknown; append?: boolean }): Promise<void>
}
interface UxpFolderEntry {
readonly isFile: false
readonly isFolder: true
readonly name: string
readonly nativePath: string
createFile(name: string, options?: { overwrite?: boolean }): Promise<UxpFileEntry>
getEntries(): Promise<UxpEntry[]>
getFiles?(): Promise<UxpFileEntry[]>
}
interface UxpLocalFileSystem {
getFileForSaving(
defaultName?: string,
options?: { types?: string[] },
): Promise<UxpFileEntry | null>
getFileForOpening(options?: {
allowMultiple?: boolean
types?: string[]
}): Promise<UxpFileEntry | UxpFileEntry[] | null>
getFolder(): Promise<UxpFolderEntry | null>
getTemporaryFolder(): Promise<UxpFolderEntry>
getDataFolder(): Promise<UxpFolderEntry>
getPluginFolder(): Promise<UxpFolderEntry>
}
interface UxpStorageFormats {
readonly binary: unknown
readonly utf8: unknown
}
interface UxpModule {
storage: {
localFileSystem: UxpLocalFileSystem
formats: UxpStorageFormats
}
}
declare module 'uxp' {
const uxp: UxpModule
export = uxp
}
+52
View File
@@ -0,0 +1,52 @@
import './polyfills'
import React from 'react'
import { createRoot } from 'react-dom/client'
import { Theme } from '@swc-react/theme'
import '@spectrum-web-components/theme/theme-dark.js'
import '@spectrum-web-components/theme/theme-darkest.js'
import '@spectrum-web-components/theme/theme-light.js'
import '@spectrum-web-components/theme/scale-medium.js'
import '@swc-uxp-wrappers/button/sp-button.js'
import '@swc-uxp-wrappers/action-button/sp-action-button.js'
import '@swc-uxp-wrappers/menu/sp-menu.js'
import '@swc-uxp-wrappers/menu/sp-menu-item.js'
import '@swc-uxp-wrappers/menu/sp-menu-divider.js'
import '@swc-uxp-wrappers/menu/sp-menu-group.js'
import '@swc-uxp-wrappers/popover/sp-popover.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-refresh.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-chevron-down.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-chevron-right.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-log-out.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-arrow-right.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-filmstrip.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-folder.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-folder-open.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-audio.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-image.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-document.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-link.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-unlink.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-link-out.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-download.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-briefcase.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-alert-circle.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-alert-triangle.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-checkmark-circle.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-close.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-movie-camera.js'
import '@spectrum-web-components/icons-workflow/icons/sp-icon-video-filled.js'
import { App } from './App'
const container = document.getElementById('root')
if (container) {
const root = createRoot(container)
root.render(
<React.StrictMode>
<Theme theme="spectrum" scale="medium" color="dark">
<App />
</Theme>
</React.StrictMode>,
)
} else {
console.error('Failed to find root container element')
}
+12
View File
@@ -0,0 +1,12 @@
// @vitest-environment happy-dom
import { describe, it, expect } from 'vitest'
import './polyfills'
describe('polyfills', () => {
it('defines window.matchMedia polyfill when missing', () => {
expect(typeof window.matchMedia).toBe('function')
const mql = window.matchMedia('(prefers-color-scheme: dark)')
expect(mql).toBeDefined()
expect(mql.matches).toBe(false)
})
})
+31
View File
@@ -0,0 +1,31 @@
// Guard against duplicate custom element registrations during UXP development and plugin reload
if (typeof window !== 'undefined' && window.customElements) {
const origDefine = window.customElements.define.bind(window.customElements)
window.customElements.define = (
name: string,
constructor: CustomElementConstructor,
options?: ElementDefinitionOptions,
) => {
if (window.customElements.get(name)) {
return
}
origDefine(name, constructor, options)
}
}
// Polyfill window.matchMedia for Adobe UXP environment
if (typeof window !== 'undefined' && typeof window.matchMedia !== 'function') {
window.matchMedia = (query: string): MediaQueryList => {
const mql: MediaQueryList = {
matches: false,
media: query,
onchange: null,
addListener: () => {},
removeListener: () => {},
addEventListener: () => {},
removeEventListener: () => {},
dispatchEvent: () => false,
}
return mql
}
}
@@ -0,0 +1,182 @@
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
import { autoSyncService } from './autoSyncService'
import type { Project, Sequence } from '@adobe/premierepro'
import type { CommentInfo } from '@shumai/dtos'
import * as premiereService from './premiere'
import * as linkStorage from './linkStorage'
import * as markersService from './markers'
describe('autoSyncService', () => {
beforeEach(() => {
vi.useFakeTimers()
vi.restoreAllMocks()
autoSyncService.stop()
})
afterEach(() => {
autoSyncService.stop()
vi.useRealTimers()
})
it('starts and stops background interval without throwing', () => {
autoSyncService.start('https://api.shumai.test', 'test-key')
expect(autoSyncService['timer']).not.toBeNull()
autoSyncService.stop()
expect(autoSyncService['timer']).toBeNull()
})
it('syncs all linked sequences on triggerImmediateSync', async () => {
const mockSeq = { guid: 'seq-1', name: 'Seq 1' }
const mockProject = { guid: 'proj-1' }
const mockLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Seq 1',
assetId: 'asset-1',
assetName: 'video.mp4',
syncedCommentIds: [],
lastSyncAt: 0,
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([mockLink])
vi.spyOn(markersService, 'fetchAssetComments').mockResolvedValue([
{ id: 'comm-1', second: 5, message: 'hello' } as unknown as CommentInfo,
])
vi.spyOn(markersService, 'syncCommentsToSequence').mockResolvedValue({
updatedLink: { ...mockLink, syncedCommentIds: ['comm-1'] },
addedCount: 1,
})
autoSyncService.start('https://api.shumai.test', 'test-key')
await autoSyncService.triggerImmediateSync()
expect(markersService.fetchAssetComments).toHaveBeenCalledWith(
'https://api.shumai.test',
'test-key',
'asset-1',
)
expect(markersService.syncCommentsToSequence).toHaveBeenCalled()
})
it('normalizes sequence GUIDs with braces and uppercase when matching against linked sequences', async () => {
const mockSeq = { guid: '{B991F605-7BD7-4028-B05F-0BC36B66CD0A}', name: 'Seq Braced' }
const mockProject = { guid: 'proj-1' }
const mockLink = {
sequenceGuid: 'b991f605-7bd7-4028-b05f-0bc36b66cd0a',
sequenceName: 'Seq Braced',
assetId: 'asset-99',
assetName: 'video.mp4',
syncedCommentIds: [],
lastSyncAt: 0,
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([mockLink])
vi.spyOn(markersService, 'fetchAssetComments').mockResolvedValue([
{ id: 'comm-1', second: 1, message: 'braced guid comment' } as unknown as CommentInfo,
])
vi.spyOn(markersService, 'syncCommentsToSequence').mockResolvedValue({
updatedLink: { ...mockLink, syncedCommentIds: ['comm-1'] },
addedCount: 1,
})
autoSyncService.start('https://api.shumai.test', 'test-key')
await autoSyncService.triggerImmediateSync()
expect(markersService.fetchAssetComments).toHaveBeenCalledWith(
'https://api.shumai.test',
'test-key',
'asset-99',
)
expect(markersService.syncCommentsToSequence).toHaveBeenCalledWith(
mockProject,
mockSeq,
expect.any(Array),
mockLink,
)
})
it('skips linked sequences configured for a different server endpoint', async () => {
const mockSeq1 = { guid: 'seq-foreign', name: 'Seq Foreign' }
const mockSeq2 = { guid: 'seq-local', name: 'Seq Local' }
const mockProject = { guid: 'proj-1' }
const foreignLink = {
sequenceGuid: 'seq-foreign',
sequenceName: 'Seq Foreign',
assetId: 'asset-foreign',
assetName: 'foreign.mp4',
endpoint: 'http://localhost:3000',
syncedCommentIds: [],
lastSyncAt: 0,
totalCommentsSynced: 0,
}
const sameLink = {
sequenceGuid: 'seq-local',
sequenceName: 'Seq Local',
assetId: 'asset-local',
assetName: 'local.mp4',
endpoint: 'https://staging.shumai.one/', // trailing slash variation
syncedCommentIds: [],
lastSyncAt: 0,
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([
mockSeq1 as unknown as Sequence,
mockSeq2 as unknown as Sequence,
])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([foreignLink, sameLink])
vi.spyOn(markersService, 'fetchAssetComments').mockResolvedValue([
{ id: 'comm-1', second: 2, message: 'comment' } as unknown as CommentInfo,
])
vi.spyOn(markersService, 'syncCommentsToSequence').mockResolvedValue({
updatedLink: { ...sameLink, syncedCommentIds: ['comm-1'] },
addedCount: 1,
})
autoSyncService.start('https://staging.shumai.one', 'test-key')
await autoSyncService.triggerImmediateSync()
// Foreign link should be skipped
expect(markersService.fetchAssetComments).not.toHaveBeenCalledWith(
expect.anything(),
expect.anything(),
'asset-foreign',
)
// Matching link should be synced
expect(markersService.fetchAssetComments).toHaveBeenCalledWith(
'https://staging.shumai.one',
'test-key',
'asset-local',
)
expect(markersService.syncCommentsToSequence).toHaveBeenCalledWith(
mockProject,
mockSeq2,
expect.any(Array),
sameLink,
)
})
it('aborts syncing when stop() is called and credentials are reset', async () => {
const fetchSpy = vi.spyOn(markersService, 'fetchAssetComments')
autoSyncService.start('https://api.shumai.test', 'test-key')
autoSyncService.stop()
await autoSyncService.triggerImmediateSync()
expect(fetchSpy).not.toHaveBeenCalled()
})
})
@@ -0,0 +1,175 @@
import type { Sequence } from '@adobe/premierepro'
import { getActiveProject, getAllSequences, getPremiereModule } from './premiere'
import { getAllLinkedSequences, normalizeGuid } from './linkStorage'
import { fetchAssetComments, syncCommentsToSequence } from './markers'
import { isSameEndpoint } from '../utils/url'
const SYNC_INTERVAL_MS = 12000 // 12 seconds
class AutoSyncService {
private timer: ReturnType<typeof setInterval> | null = null
private endpoint = ''
private apiKey = ''
private cleanupListeners: (() => void) | null = null
private syncPromise: Promise<void> | null = null
/**
* Starts the background auto-sync loop.
*/
start(endpoint: string, apiKey: string): void {
this.stop()
this.endpoint = endpoint
this.apiKey = apiKey
if (!endpoint || !apiKey) return
// Setup background interval
this.timer = setInterval(() => {
void this.syncAllLinkedSequences()
}, SYNC_INTERVAL_MS)
// Setup host and window event listeners
this.setupListeners()
}
/**
* Stops the background auto-sync loop and tears down listeners.
*/
stop(): void {
if (this.timer) {
clearInterval(this.timer)
this.timer = null
}
if (this.cleanupListeners) {
this.cleanupListeners()
this.cleanupListeners = null
}
this.endpoint = ''
this.apiKey = ''
this.syncPromise = null
}
/**
* Forces an immediate synchronization cycle.
*/
async triggerImmediateSync(): Promise<void> {
if (this.syncPromise) {
await this.syncPromise
}
await this.syncAllLinkedSequences()
}
private setupListeners(): void {
const onFocus = () => {
void this.triggerImmediateSync()
}
const onVisibilityChange = () => {
if (typeof document !== 'undefined' && document.visibilityState === 'visible') {
void this.triggerImmediateSync()
}
}
if (typeof window !== 'undefined') {
window.addEventListener('focus', onFocus)
}
if (typeof document !== 'undefined') {
document.addEventListener('visibilitychange', onVisibilityChange)
}
// Premiere Pro Sequence Activated listener
const ppro = getPremiereModule()
let hasSeqListener = false
const onSequenceActivated = () => {
void this.triggerImmediateSync()
}
if (ppro?.EventManager && ppro.Constants?.SequenceEvent?.ACTIVATED) {
try {
ppro.EventManager.addGlobalEventListener(
ppro.Constants.SequenceEvent.ACTIVATED,
onSequenceActivated,
)
hasSeqListener = true
} catch (err) {
console.warn('[autoSyncService] Could not register SequenceEvent listener:', err)
}
}
this.cleanupListeners = () => {
if (typeof window !== 'undefined') {
window.removeEventListener('focus', onFocus)
}
if (typeof document !== 'undefined') {
document.removeEventListener('visibilitychange', onVisibilityChange)
}
if (hasSeqListener && ppro?.EventManager && ppro.Constants?.SequenceEvent?.ACTIVATED) {
try {
ppro.EventManager.removeGlobalEventListener(
ppro.Constants.SequenceEvent.ACTIVATED,
onSequenceActivated,
)
} catch {
// Ignore error during cleanup
}
}
}
}
private async syncAllLinkedSequences(): Promise<void> {
if (this.syncPromise) {
return this.syncPromise
}
const currentEndpoint = this.endpoint
const currentApiKey = this.apiKey
if (!currentEndpoint || !currentApiKey) return
this.syncPromise = (async () => {
try {
const project = await getActiveProject()
if (!project || this.endpoint !== currentEndpoint || this.apiKey !== currentApiKey) return
const allSeqs = await getAllSequences(project)
if (!allSeqs || allSeqs.length === 0 || this.endpoint !== currentEndpoint) return
const linkedItems = await getAllLinkedSequences(project, allSeqs)
if (!linkedItems || linkedItems.length === 0 || this.endpoint !== currentEndpoint) return
const seqsMap = new Map<string, Sequence>()
for (const s of allSeqs) {
const normGuid = normalizeGuid(s.guid)
if (normGuid) {
seqsMap.set(normGuid, s)
}
}
for (const link of linkedItems) {
if (this.endpoint !== currentEndpoint || this.apiKey !== currentApiKey) break
// Skip links created against a different server endpoint
if (link.endpoint && !isSameEndpoint(link.endpoint, currentEndpoint)) {
continue
}
const targetSeq = seqsMap.get(normalizeGuid(link.sequenceGuid))
if (!targetSeq) continue
try {
const comments = await fetchAssetComments(currentEndpoint, currentApiKey, link.assetId)
if (this.endpoint !== currentEndpoint) break
await syncCommentsToSequence(project, targetSeq, comments, link)
} catch (itemErr) {
console.error(`[autoSyncService] Error syncing sequence ${link.sequenceName}:`, itemErr)
}
}
} catch (err) {
console.error('[autoSyncService] Sync cycle failed:', err)
} finally {
this.syncPromise = null
}
})()
return this.syncPromise
}
}
export const autoSyncService = new AutoSyncService()
@@ -0,0 +1,124 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import { fetchAssetComments, formatCommentBody } from './commentUtils'
import * as clientModule from '../api/client'
import type { CommentInfo } from '@shumai/dtos'
describe('commentUtils', () => {
beforeEach(() => {
vi.restoreAllMocks()
})
describe('fetchAssetComments', () => {
it('returns comments array when response is ok', async () => {
const mockComments: Partial<CommentInfo>[] = [
{ id: 'c1', message: 'First comment', second: 12 },
{ id: 'c2', message: 'Second comment', second: 45 },
]
const mockGet = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({ data: mockComments }),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
':fileId': {
comments: {
$get: mockGet,
},
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const result = await fetchAssetComments('https://api.shumai.test', 'test-key', 'asset-1')
expect(mockGet).toHaveBeenCalledWith({
param: { fileId: 'asset-1' },
query: { first: '100' },
})
expect(result).toEqual(mockComments)
})
it('throws error with message from server response when res.ok is false', async () => {
const mockGet = vi.fn().mockResolvedValue({
ok: false,
status: 404,
json: async () => ({ error: 'Asset not found on this server' }),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
':fileId': {
comments: {
$get: mockGet,
},
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await expect(
fetchAssetComments('https://api.shumai.test', 'test-key', 'asset-missing'),
).rejects.toThrow('Asset not found on this server')
})
it('throws fallback HTTP status error when res.ok is false and response has no error field', async () => {
const mockGet = vi.fn().mockResolvedValue({
ok: false,
status: 500,
json: async () => {
throw new Error('Invalid JSON')
},
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
':fileId': {
comments: {
$get: mockGet,
},
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await expect(
fetchAssetComments('https://api.shumai.test', 'test-key', 'asset-crash'),
).rejects.toThrow('Failed to fetch comments (HTTP 500)')
})
})
describe('formatCommentBody', () => {
it('formats single comment without replies', () => {
const comment = {
message: 'Review cut at 01:23',
replies: [],
} as unknown as CommentInfo
expect(formatCommentBody(comment)).toBe('Review cut at 01:23')
})
it('formats comment with nested replies and authors', () => {
const comment = {
message: 'Needs color correction',
replies: [
{ creator: { name: 'Alice' }, message: 'Applied LUT' },
{ creator: { name: 'Bob' }, message: 'Looks better' },
],
} as unknown as CommentInfo
const result = formatCommentBody(comment)
expect(result).toContain('Needs color correction')
expect(result).toContain('--- Replies ---')
expect(result).toContain('Alice: Applied LUT')
expect(result).toContain('Bob: Looks better')
})
})
})
@@ -0,0 +1,43 @@
import type { CommentInfo } from '@shumai/dtos'
import { getShumaiClient } from '../api/client'
/**
* Fetches timecoded comments for an asset from Shumai.
*/
export async function fetchAssetComments(
endpoint: string,
apiKey: string,
assetId: string,
): Promise<CommentInfo[]> {
const client = getShumaiClient(endpoint, apiKey)
const res = await client.api.files[':fileId'].comments.$get({
param: { fileId: assetId },
query: { first: '100' },
})
if (!res.ok) {
const errData = (await res.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to fetch comments (HTTP ${res.status})`)
}
const data = await res.json()
return (data?.data as CommentInfo[]) || []
}
/**
* Formats a Shumai comment into marker text including any threaded replies.
*/
export function formatCommentBody(comment: CommentInfo): string {
let body = comment.message || ''
if (comment.replies && comment.replies.length > 0) {
body += '\n\n--- Replies ---'
for (const reply of comment.replies) {
const author = reply.creator?.name || 'User'
const replyMsg = reply.message || ''
body += `\n${author}: ${replyMsg}`
}
}
return body
}
@@ -0,0 +1,619 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import {
formatResolutionLabel,
getResolutionRank,
resolveRawDownloadUrl,
fetchVideoProxies,
getUniqueFileName,
getFolderEntryNames,
createUniqueFileInFolder,
importAssetIntoPremiere,
} from './import'
import * as premiereModule from './premiere'
import * as clientModule from '../api/client'
import type { AssetSummary } from '../components/FileItem'
describe('import service', () => {
beforeEach(() => {
vi.restoreAllMocks()
})
describe('formatResolutionLabel', () => {
it('formats given resolution strings', () => {
expect(formatResolutionLabel(undefined, undefined, '1080p')).toBe('1080p (MP4)')
expect(formatResolutionLabel(undefined, undefined, '720')).toBe('720p (MP4)')
})
it('formats given height numbers', () => {
expect(formatResolutionLabel(1920, 1080)).toBe('1080p (MP4)')
expect(formatResolutionLabel(1280, 720)).toBe('720p (MP4)')
})
it('formats by width if height is missing', () => {
expect(formatResolutionLabel(1920, undefined)).toBe('1080p (MP4)')
expect(formatResolutionLabel(1280, undefined)).toBe('720p (MP4)')
expect(formatResolutionLabel(3840, undefined)).toBe('2160p (MP4)')
})
it('falls back to Proxy (MP4)', () => {
expect(formatResolutionLabel(undefined, undefined)).toBe('Proxy (MP4)')
})
})
describe('getResolutionRank', () => {
it('extracts resolution numeric rank', () => {
expect(getResolutionRank('1080p (MP4)')).toBe(1080)
expect(getResolutionRank('720p (MP4)')).toBe(720)
expect(getResolutionRank('Proxy (MP4)')).toBe(0)
})
})
describe('resolveRawDownloadUrl', () => {
it('resolves directly via download-url when original key is in knownAsset', async () => {
const mockDownloadUrlPost = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({ url: 'https://s3.example.com/direct-raw.mp4' }),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-url': {
$post: mockDownloadUrlPost,
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const knownAsset: AssetSummary = {
id: 'file-1',
name: 'direct-raw.mp4',
type: 'file',
media: {
original: {
key: 'files/test/direct-raw.mp4',
},
},
}
const result = await resolveRawDownloadUrl('http://test', 'key', 'file-1', knownAsset)
expect(result.url).toBe('https://s3.example.com/direct-raw.mp4')
expect(result.name).toBe('direct-raw.mp4')
expect(mockDownloadUrlPost).toHaveBeenCalledWith({
json: { key: 'files/test/direct-raw.mp4', assetId: 'file-1' },
})
})
it('resolves via GET :fileId and download-url when not in knownAsset', async () => {
const mockGet = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
id: 'file-1',
name: 'remote-video.mp4',
media: {
original: {
key: 'files/remote/video.mp4',
},
},
}),
})
const mockDownloadUrlPost = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({ url: 'https://s3.example.com/presigned-remote.mp4' }),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
':fileId': {
$get: mockGet,
},
'download-url': {
$post: mockDownloadUrlPost,
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const result = await resolveRawDownloadUrl('http://test', 'key', 'file-1')
expect(result.url).toBe('https://s3.example.com/presigned-remote.mp4')
expect(result.name).toBe('remote-video.mp4')
expect(mockGet).toHaveBeenCalledWith({ param: { fileId: 'file-1' } })
expect(mockDownloadUrlPost).toHaveBeenCalledWith({
json: { key: 'files/remote/video.mp4', assetId: 'file-1' },
})
})
it('falls back to download-links endpoint when download-url is unavailable', async () => {
const mockPost = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
files: [{ id: 'file-1', name: 'video.mov', url: 'https://s3.example.com/video.mov' }],
}),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: mockPost,
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const result = await resolveRawDownloadUrl('http://test', 'key', 'file-1')
expect(result.url).toBe('https://s3.example.com/video.mov')
expect(result.name).toBe('video.mov')
expect(mockPost).toHaveBeenCalledWith({ json: { ids: ['file-1'] } })
})
it('throws error when all resolution methods fail', async () => {
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: vi.fn().mockResolvedValue({
ok: false,
status: 500,
json: async () => ({ error: 'Server error' }),
}),
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await expect(resolveRawDownloadUrl('http://test', 'key', 'file-1')).rejects.toThrow(
'Server error',
)
})
})
describe('fetchVideoProxies', () => {
it('returns available proxies sorted descending', async () => {
const mockGet = vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
id: 'file-1',
media: {
videoTranscodes: [
{
id: 't-720',
key: 'files/720.mp4',
url: 'https://s3.example.com/720.mp4',
width: 1280,
height: 720,
},
{
id: 't-1080',
key: 'files/1080.mp4',
url: 'https://s3.example.com/1080.mp4',
width: 1920,
height: 1080,
},
],
},
}),
})
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
':fileId': {
$get: mockGet,
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const proxies = await fetchVideoProxies('http://test', 'key', 'file-1')
expect(proxies).toHaveLength(2)
// Highest resolution first
expect(proxies[0].label).toBe('1080p (MP4)')
expect(proxies[1].label).toBe('720p (MP4)')
})
})
describe('getUniqueFileName', () => {
it('returns exact name when no collision exists', () => {
expect(getUniqueFileName([], 'image.png')).toBe('image.png')
expect(getUniqueFileName(['other.png', 'test.mov'], 'image.png')).toBe('image.png')
})
it('appends _1 on first collision', () => {
expect(getUniqueFileName(['image.png'], 'image.png')).toBe('image_1.png')
})
it('appends _2 when original and _1 both exist', () => {
expect(getUniqueFileName(['image.png', 'image_1.png'], 'image.png')).toBe('image_2.png')
})
it('handles case-insensitive collision checks', () => {
expect(getUniqueFileName(['IMAGE.PNG'], 'image.png')).toBe('image_1.png')
expect(getUniqueFileName(['image.png', 'IMAGE_1.PNG'], 'image.png')).toBe('image_2.png')
})
it('handles files without extensions', () => {
expect(getUniqueFileName(['README'], 'README')).toBe('README_1')
expect(getUniqueFileName(['README', 'README_1'], 'README')).toBe('README_2')
})
it('handles files with multiple dots', () => {
expect(getUniqueFileName(['archive.tar.gz'], 'archive.tar.gz')).toBe('archive.tar_1.gz')
expect(getUniqueFileName(['archive.tar.gz', 'archive.tar_1.gz'], 'archive.tar.gz')).toBe(
'archive.tar_2.gz',
)
})
})
describe('getFolderEntryNames', () => {
it('reads entry names from folder.getEntries', async () => {
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'dir',
nativePath: '/path/dir',
createFile: vi.fn(),
getEntries: vi.fn().mockResolvedValue([
{ name: 'file1.mp4', isFile: true, isFolder: false },
{ name: 'subfolder', isFile: false, isFolder: true },
]),
}
const names = await getFolderEntryNames(mockFolder)
expect(names).toEqual(['file1.mp4', 'subfolder'])
})
it('handles folder.getEntries error gracefully', async () => {
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'dir',
nativePath: '/path/dir',
createFile: vi.fn(),
getEntries: vi.fn().mockRejectedValue(new Error('Permission denied')),
}
const names = await getFolderEntryNames(mockFolder)
expect(names).toEqual([])
})
})
describe('createUniqueFileInFolder', () => {
it('creates file with candidate name when no collision', async () => {
const mockCreatedFile = {
isFile: true as const,
isFolder: false as const,
name: 'test.mp4',
nativePath: '/path/test.mp4',
write: vi.fn(),
}
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'dir',
nativePath: '/path/dir',
createFile: vi.fn().mockResolvedValue(mockCreatedFile),
getEntries: vi.fn().mockResolvedValue([]),
}
const res = await createUniqueFileInFolder(mockFolder, 'test.mp4')
expect(res.name).toBe('test.mp4')
expect(res.file).toBe(mockCreatedFile)
expect(mockFolder.createFile).toHaveBeenCalledWith('test.mp4', { overwrite: false })
})
it('auto-increments suffix when candidate creation fails due to collision', async () => {
const mockCreatedFile = {
isFile: true as const,
isFolder: false as const,
name: 'test_1.mp4',
nativePath: '/path/test_1.mp4',
write: vi.fn(),
}
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'dir',
nativePath: '/path/dir',
createFile: vi
.fn()
.mockRejectedValueOnce(new Error('File exists'))
.mockResolvedValueOnce(mockCreatedFile),
getEntries: vi.fn().mockResolvedValue([]),
}
const res = await createUniqueFileInFolder(mockFolder, 'test.mp4')
expect(res.name).toBe('test_1.mp4')
expect(res.file).toBe(mockCreatedFile)
})
})
describe('importAssetIntoPremiere', () => {
const mockAsset: AssetSummary = {
id: 'asset-1',
name: 'Sample.mov',
type: 'file',
}
it('returns error when no active project in Premiere', async () => {
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue(null)
const result = await importAssetIntoPremiere({
endpoint: 'http://test',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
})
expect(result.success).toBe(false)
expect(result.message).toContain('Please open or create a project')
})
it('returns cancelled when user cancels folder picker', async () => {
// Mocking incomplete Premiere Project object in unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue({} as any)
vi.spyOn(premiereModule, 'promptSelectFolder').mockResolvedValue(null)
const result = await importAssetIntoPremiere({
endpoint: 'http://test',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
})
expect(result.success).toBe(false)
expect(result.cancelled).toBe(true)
expect(premiereModule.promptSelectFolder).toHaveBeenCalled()
})
it('fails after folder selection if download link resolution fails', async () => {
// Mocking incomplete Premiere Project object in unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue({} as any)
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'dir',
nativePath: '/path/dir',
createFile: vi.fn(),
getEntries: vi.fn().mockResolvedValue([]),
}
vi.spyOn(premiereModule, 'promptSelectFolder').mockResolvedValue(mockFolder)
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: vi.fn().mockResolvedValue({
ok: false,
status: 401,
json: async () => ({ error: 'Unauthorized: Invalid API Key' }),
}),
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
await expect(
importAssetIntoPremiere({
endpoint: 'http://test',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
}),
).rejects.toThrow('Unauthorized: Invalid API Key')
})
it('downloads and imports file successfully with original name when no conflict', async () => {
// Mocking incomplete Premiere Project object in unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const mockProject = {} as any
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue(mockProject)
const mockSaveFile = {
isFile: true as const,
isFolder: false as const,
name: 'Sample.mov',
nativePath: '/Users/test/Downloads/Sample.mov',
write: vi.fn().mockResolvedValue(undefined),
}
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'Downloads',
nativePath: '/Users/test/Downloads',
createFile: vi.fn().mockResolvedValue(mockSaveFile),
getEntries: vi.fn().mockResolvedValue([]),
}
vi.spyOn(premiereModule, 'promptSelectFolder').mockResolvedValue(mockFolder)
vi.spyOn(premiereModule, 'writeBinaryFile').mockResolvedValue(undefined)
vi.spyOn(premiereModule, 'importFilesIntoProject').mockResolvedValue(true)
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
files: [{ id: 'asset-1', name: 'Sample.mov', url: 'https://s3.example.com/raw' }],
}),
}),
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
// Mock global fetch
const dummyBuffer = new ArrayBuffer(8)
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
ok: true,
arrayBuffer: async () => dummyBuffer,
// Mocking Response object for unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const onProgress = vi.fn()
const result = await importAssetIntoPremiere({
endpoint: 'http://test',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
onProgress,
})
expect(result.success).toBe(true)
expect(result.fileName).toBe('Sample.mov')
expect(result.message).toContain('Successfully imported Sample.mov')
expect(mockFolder.createFile).toHaveBeenCalledWith('Sample.mov', { overwrite: false })
expect(premiereModule.importFilesIntoProject).toHaveBeenCalledWith(mockProject, [
'/Users/test/Downloads/Sample.mov',
])
expect(onProgress).toHaveBeenCalled()
fetchSpy.mockRestore()
})
it('automatically adds _1 suffix when name conflict exists in selected folder', async () => {
// Mocking incomplete Premiere Project object in unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const mockProject = {} as any
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue(mockProject)
const mockSaveFile = {
isFile: true as const,
isFolder: false as const,
name: 'Sample_1.mov',
nativePath: '/Users/test/Downloads/Sample_1.mov',
write: vi.fn().mockResolvedValue(undefined),
}
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'Downloads',
nativePath: '/Users/test/Downloads',
createFile: vi.fn().mockResolvedValue(mockSaveFile),
getEntries: vi
.fn()
.mockResolvedValue([{ name: 'Sample.mov', isFile: true, isFolder: false }]),
}
vi.spyOn(premiereModule, 'promptSelectFolder').mockResolvedValue(mockFolder)
vi.spyOn(premiereModule, 'writeBinaryFile').mockResolvedValue(undefined)
vi.spyOn(premiereModule, 'importFilesIntoProject').mockResolvedValue(true)
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
files: [{ id: 'asset-1', name: 'Sample.mov', url: 'https://s3.example.com/raw' }],
}),
}),
},
},
},
// Partial mock of Hono client for unit test isolation
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const dummyBuffer = new ArrayBuffer(8)
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
ok: true,
arrayBuffer: async () => dummyBuffer,
// Mocking Response object for unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const result = await importAssetIntoPremiere({
endpoint: 'http://test',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
})
expect(result.success).toBe(true)
expect(result.fileName).toBe('Sample_1.mov')
expect(result.message).toContain('Successfully imported Sample_1.mov')
expect(mockFolder.createFile).toHaveBeenCalledWith('Sample_1.mov', { overwrite: false })
expect(premiereModule.importFilesIntoProject).toHaveBeenCalledWith(mockProject, [
'/Users/test/Downloads/Sample_1.mov',
])
fetchSpy.mockRestore()
})
it('resolves relative download URL with endpoint before fetching', async () => {
// Mocking incomplete Premiere Project object in unit test
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const mockProject = {} as any
vi.spyOn(premiereModule, 'getActiveProject').mockResolvedValue(mockProject)
const mockSaveFile = {
isFile: true as const,
isFolder: false as const,
name: 'Sample.mov',
nativePath: '/Users/test/Downloads/Sample.mov',
write: vi.fn().mockResolvedValue(undefined),
}
const mockFolder = {
isFile: false as const,
isFolder: true as const,
name: 'Downloads',
nativePath: '/Users/test/Downloads',
createFile: vi.fn().mockResolvedValue(mockSaveFile),
getEntries: vi.fn().mockResolvedValue([]),
}
vi.spyOn(premiereModule, 'promptSelectFolder').mockResolvedValue(mockFolder)
vi.spyOn(premiereModule, 'writeBinaryFile').mockResolvedValue(undefined)
vi.spyOn(premiereModule, 'importFilesIntoProject').mockResolvedValue(true)
vi.spyOn(clientModule, 'getShumaiClient').mockReturnValue({
api: {
files: {
'download-links': {
$post: vi.fn().mockResolvedValue({
ok: true,
json: async () => ({
files: [{ id: 'asset-1', name: 'Sample.mov', url: '/api/upload/local?key=test' }],
}),
}),
},
},
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const dummyBuffer = new ArrayBuffer(8)
const fetchSpy = vi.spyOn(globalThis, 'fetch').mockResolvedValue({
ok: true,
arrayBuffer: async () => dummyBuffer,
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} as any)
const result = await importAssetIntoPremiere({
endpoint: 'http://test:3000',
apiKey: 'key',
asset: mockAsset,
type: 'raw',
})
expect(result.success).toBe(true)
expect(fetchSpy).toHaveBeenCalledWith('http://test:3000/api/upload/local?key=test')
fetchSpy.mockRestore()
})
})
})
+357
View File
@@ -0,0 +1,357 @@
import { getShumaiClient } from '../api/client'
import type { AssetSummary } from '../components/FileItem'
import {
getActiveProject,
importFilesIntoProject,
promptSelectFolder,
writeBinaryFile,
} from './premiere'
import { resolveAssetUrl } from '../utils/url'
export interface ProxyOption {
id: string
label: string
resolution: string
url: string
key: string
width?: number
height?: number
size?: number
}
export function formatResolutionLabel(width?: number, height?: number, res?: string): string {
if (res) {
const cleanRes = res.endsWith('p') ? res : `${res}p`
return `${cleanRes} (MP4)`
}
if (height) return `${height}p (MP4)`
if (width) {
if (width >= 3840) return '2160p (MP4)'
if (width >= 1920) return '1080p (MP4)'
if (width >= 1280) return '720p (MP4)'
if (width >= 960) return '540p (MP4)'
if (width >= 640) return '360p (MP4)'
}
return 'Proxy (MP4)'
}
export function getResolutionRank(label: string): number {
const match = label.match(/(\d+)p/) || label.match(/^(\d+)/)
return match ? parseInt(match[1], 10) : 0
}
/**
* Resolves the presigned download URL for the original / raw file.
*/
export async function resolveRawDownloadUrl(
endpoint: string,
apiKey: string,
assetId: string,
knownAsset?: AssetSummary,
): Promise<{ url: string; name?: string }> {
const client = getShumaiClient(endpoint, apiKey)
// 1. If original key is known directly from asset summary, presign via download-url endpoint
const directKey = knownAsset?.media?.original?.key
if (directKey) {
try {
const res = await client.api.files['download-url']?.$post({
json: { key: directKey, assetId },
})
if (res?.ok) {
const data = await res.json()
if (data.url) {
return { url: data.url, name: knownAsset?.name }
}
}
} catch (err) {
console.warn('Failed to resolve download URL via known key:', err)
}
}
// 2. Fetch full asset details via GET /api/files/:fileId to get the original media key
try {
const detailRes = await client.api.files[':fileId']?.$get({
param: { fileId: assetId },
})
if (detailRes?.ok) {
const assetData = await detailRes.json()
const originalKey = assetData.media?.original?.key
if (originalKey) {
const urlRes = await client.api.files['download-url']?.$post({
json: { key: originalKey, assetId },
})
if (urlRes?.ok) {
const urlData = await urlRes.json()
if (urlData.url) {
return { url: urlData.url, name: assetData.name || knownAsset?.name }
}
}
}
}
} catch (err) {
console.warn('Failed to fetch asset details for download URL:', err)
}
// 3. Fallback to POST /api/files/download-links batch resolution
const res = await client.api.files['download-links']?.$post({
json: { ids: [assetId] },
})
if (res?.ok) {
const data = await res.json()
const file = data.files?.[0]
if (file?.url) {
return { url: file.url, name: file.name || knownAsset?.name }
}
} else if (res) {
const errData = (await res.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to get download link (${res.status})`)
}
throw new Error('No download URL returned from server.')
}
/**
* Fetches available video proxy transcodes for an asset.
*/
export async function fetchVideoProxies(
endpoint: string,
apiKey: string,
assetId: string,
): Promise<ProxyOption[]> {
const client = getShumaiClient(endpoint, apiKey)
const res = await client.api.files[':fileId'].$get({
param: { fileId: assetId },
})
if (!res.ok) {
const errData = (await res.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to get asset details (${res.status})`)
}
const asset = await res.json()
const transcodes = asset.media?.videoTranscodes || []
if (!transcodes.length) return []
const proxies: ProxyOption[] = []
for (const t of transcodes) {
let url = t.url
if (!url && t.key) {
// If transcode url wasn't presigned yet, request via download-url endpoint
try {
const urlRes = await client.api.files['download-url'].$post({
json: { key: t.key, assetId },
})
if (urlRes.ok) {
const urlData = await urlRes.json()
url = urlData.url
}
} catch (err) {
console.warn(`Failed to presign transcode key ${t.key}:`, err)
}
}
if (url) {
const label = formatResolutionLabel(t.width, t.height)
proxies.push({
id: t.id || t.key,
label,
resolution: `${t.height || 0}p`,
url,
key: t.key,
width: t.width,
height: t.height,
size: t.size,
})
}
}
// Sort descending by resolution (1080p, 720p, 540p, 360p)
proxies.sort((a, b) => getResolutionRank(b.label) - getResolutionRank(a.label))
return proxies
}
/**
* Resolves a unique filename within the specified existing file names in a folder.
* If requestedName exists, it appends _1, _2, etc. before the file extension.
* Comparison is case-insensitive to safely handle Windows and macOS filesystems.
*/
export function getUniqueFileName(existingNames: string[], requestedName: string): string {
const existingSet = new Set(existingNames.map((n) => n.toLowerCase()))
if (!existingSet.has(requestedName.toLowerCase())) {
return requestedName
}
const dotIndex = requestedName.lastIndexOf('.')
const base = dotIndex > 0 ? requestedName.slice(0, dotIndex) : requestedName
const ext = dotIndex > 0 ? requestedName.slice(dotIndex) : ''
let counter = 1
while (true) {
const candidate = `${base}_${counter}${ext}`
if (!existingSet.has(candidate.toLowerCase())) {
return candidate
}
counter++
}
}
/**
* Reads existing file/folder names inside a UXP FolderEntry safely.
*/
export async function getFolderEntryNames(folder: UxpFolderEntry): Promise<string[]> {
try {
if (typeof folder.getEntries === 'function') {
const entries = await folder.getEntries()
return entries.map((e) => e.name)
}
const folderRecord = folder as unknown as Record<string, unknown>
if (typeof folderRecord.getFiles === 'function') {
const files = await (folderRecord.getFiles as () => Promise<Array<{ name: string }>>)()
return files.map((f) => f.name)
}
} catch (err) {
console.warn('Failed to read folder entries:', err)
}
return []
}
/**
* Creates a unique file entry in the target folder, preventing overwrites by auto-incrementing suffixes (_1, _2).
*/
export async function createUniqueFileInFolder(
folder: UxpFolderEntry,
requestedName: string,
): Promise<{ file: UxpFileEntry; name: string }> {
const existingNames = await getFolderEntryNames(folder)
const candidateName = getUniqueFileName(existingNames, requestedName)
try {
const file = await folder.createFile(candidateName, { overwrite: false })
return { file, name: candidateName }
} catch (err) {
console.warn(`Could not create file "${candidateName}" with overwrite: false, retrying...`, err)
const dotIndex = requestedName.lastIndexOf('.')
const base = dotIndex > 0 ? requestedName.slice(0, dotIndex) : requestedName
const ext = dotIndex > 0 ? requestedName.slice(dotIndex) : ''
for (let counter = 1; counter <= 50; counter++) {
const retryName = `${base}_${counter}${ext}`
try {
const file = await folder.createFile(retryName, { overwrite: false })
return { file, name: retryName }
} catch {
continue
}
}
const fallbackFile = await folder.createFile(candidateName, { overwrite: true })
return { file: fallbackFile, name: candidateName }
}
}
export interface ImportAssetOptions {
endpoint: string
apiKey: string
asset: AssetSummary
type: 'raw' | 'proxy'
proxyItem?: ProxyOption
onProgress?: (message: string) => void
}
export interface ImportResult {
success: boolean
cancelled?: boolean
message: string
fileName?: string
}
/**
* Orchestrates the full import workflow:
* 1. Checks active Premiere Pro project
* 2. Prompts user with native folder picker (Frame.io pattern)
* 3. Resolves download URL from Shumai S3 presigned URL
* 4. Resolves unique filename in folder with auto-increment (_1, _2) on collision
* 5. Downloads binary data and writes to disk
* 6. Calls Premiere project.importFiles
*/
export async function importAssetIntoPremiere({
endpoint,
apiKey,
asset,
type,
proxyItem,
onProgress,
}: ImportAssetOptions): Promise<ImportResult> {
// 1. Verify active Premiere project
const project = await getActiveProject()
if (!project) {
return {
success: false,
message: 'Please open or create a project in Premiere Pro first.',
}
}
// 2. Open native folder picker (Frame.io pattern)
const targetFolder = await promptSelectFolder()
if (!targetFolder) {
return {
success: false,
cancelled: true,
message: 'Import cancelled by user.',
}
}
// 3. Determine default filename & download URL
onProgress?.('Preparing download link...')
let downloadUrl: string
let defaultFileName: string
if (type === 'raw') {
const rawInfo = await resolveRawDownloadUrl(endpoint, apiKey, asset.id, asset)
downloadUrl = rawInfo.url
defaultFileName = rawInfo.name || asset.name
} else {
if (!proxyItem?.url) {
throw new Error('Proxy URL not available.')
}
downloadUrl = proxyItem.url
const rawName = asset.name
const dotIndex = rawName.lastIndexOf('.')
const baseName = dotIndex !== -1 ? rawName.slice(0, dotIndex) : rawName
const resTag = proxyItem ? proxyItem.label.split(' ')[0] : 'proxy'
defaultFileName = `${baseName}_proxy_${resTag}.mp4`
}
const resolvedDownloadUrl = resolveAssetUrl(downloadUrl, endpoint) || downloadUrl
// 4. Create unique file in destination folder with collision avoidance (_1, _2)
const { file: saveFile, name: finalFileName } = await createUniqueFileInFolder(
targetFolder,
defaultFileName,
)
// 5. Download binary data
onProgress?.(`Downloading ${finalFileName}...`)
const response = await fetch(resolvedDownloadUrl)
if (!response.ok) {
throw new Error(`Failed to download file (HTTP ${response.status})`)
}
const arrayBuffer = await response.arrayBuffer()
// 6. Write file to disk
onProgress?.(`Saving ${finalFileName} to disk...`)
await writeBinaryFile(saveFile, arrayBuffer)
// 7. Import into Premiere Pro
onProgress?.('Importing into Premiere Pro...')
const imported = await importFilesIntoProject(project, [saveFile.nativePath])
if (!imported) {
throw new Error(`Premiere Pro could not import "${finalFileName}".`)
}
return {
success: true,
fileName: finalFileName,
message: `Successfully imported ${finalFileName} into Premiere Pro.`,
}
}
@@ -0,0 +1,548 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import {
saveSequenceLinkToCache,
getSequenceLinkFromCache,
removeSequenceLinkFromCache,
getAllSequenceLinksFromCache,
getAllLinkedSequences,
getSequenceLink,
saveSequenceLink,
removeSequenceLink,
normalizeGuid,
LINK_STORAGE_PROP_KEY,
} from './linkStorage'
import * as commentUtils from './commentUtils'
import type { Project, Sequence } from '@adobe/premierepro'
import type { LinkedSequenceAsset } from '../types/link'
const localStorageMock = (() => {
let store: Record<string, string> = {}
return {
getItem: (key: string) => store[key] || null,
setItem: (key: string, value: string) => {
store[key] = value.toString()
},
removeItem: (key: string) => {
delete store[key]
},
clear: () => {
store = {}
},
key: (index: number) => Object.keys(store)[index] || null,
get length() {
return Object.keys(store).length
},
}
})()
Object.defineProperty(globalThis, 'localStorage', {
value: localStorageMock,
configurable: true,
writable: true,
})
describe('linkStorage service', () => {
beforeEach(() => {
localStorage.clear()
vi.restoreAllMocks()
// Reset global require
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).require
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).window
})
const sampleLink: LinkedSequenceAsset = {
sequenceGuid: 'seq-guid-1',
sequenceName: 'Sequence 01',
assetId: 'asset-1',
assetName: 'video.mp4',
syncedCommentIds: ['comm-1', 'comm-2'],
lastSyncAt: 1000,
totalCommentsSynced: 2,
}
describe('cache operations (localStorage)', () => {
it('saves and retrieves link from cache', () => {
saveSequenceLinkToCache(sampleLink, 'proj-1')
const result = getSequenceLinkFromCache('seq-guid-1', 'proj-1')
expect(result).toEqual(sampleLink)
})
it('saves and retrieves link with endpoint from cache', () => {
const linkWithEndpoint: LinkedSequenceAsset = {
...sampleLink,
endpoint: 'https://staging.shumai.one',
}
saveSequenceLinkToCache(linkWithEndpoint, 'proj-1')
const result = getSequenceLinkFromCache('seq-guid-1', 'proj-1')
expect(result?.endpoint).toBe('https://staging.shumai.one')
})
it('returns null when link is not in cache', () => {
expect(getSequenceLinkFromCache('unknown-seq', 'proj-1')).toBeNull()
})
it('lists all links for a project', () => {
saveSequenceLinkToCache(sampleLink, 'proj-1')
const link2: LinkedSequenceAsset = {
...sampleLink,
sequenceGuid: 'seq-guid-2',
sequenceName: 'Sequence 02',
}
saveSequenceLinkToCache(link2, 'proj-1')
const all = getAllSequenceLinksFromCache('proj-1')
expect(all).toHaveLength(2)
expect(all.map((l) => l.sequenceGuid)).toContain('seq-guid-1')
expect(all.map((l) => l.sequenceGuid)).toContain('seq-guid-2')
})
it('removes a link from cache', () => {
saveSequenceLinkToCache(sampleLink, 'proj-1')
expect(getSequenceLinkFromCache('seq-guid-1', 'proj-1')).not.toBeNull()
removeSequenceLinkFromCache('seq-guid-1', 'proj-1')
expect(getSequenceLinkFromCache('seq-guid-1', 'proj-1')).toBeNull()
})
it('returns all links across projects when projectGuid is omitted', () => {
saveSequenceLinkToCache(sampleLink, 'proj-1')
const link2: LinkedSequenceAsset = {
...sampleLink,
sequenceGuid: 'seq-guid-2',
sequenceName: 'Sequence 02',
assetId: 'asset-2',
}
saveSequenceLinkToCache(link2, 'proj-2')
const all = getAllSequenceLinksFromCache()
expect(all).toHaveLength(2)
expect(all.map((l) => l.sequenceGuid)).toContain('seq-guid-1')
expect(all.map((l) => l.sequenceGuid)).toContain('seq-guid-2')
})
it('does not return links from default cache when projectGuid is specified', () => {
saveSequenceLinkToCache(sampleLink, null)
const result = getAllSequenceLinksFromCache('proj-unknown')
expect(result).toEqual([])
})
})
describe('host sequence properties integration', () => {
it('retrieves persistent property from sequence when available', async () => {
const mockProps = {
getValue: vi.fn().mockReturnValue(JSON.stringify(sampleLink)),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const mockProj = { guid: 'proj-1' }
const link = await getSequenceLink(
mockSeq as unknown as Sequence,
mockProj as unknown as Project,
)
expect(link).toEqual(sampleLink)
expect(mockProps.getValue).toHaveBeenCalledWith(LINK_STORAGE_PROP_KEY)
})
it('saves persistent property and executes transaction', async () => {
const mockCompoundAction = { addAction: vi.fn() }
const mockProps = {
createSetValueAction: vi.fn().mockReturnValue({ id: 'action-set' }),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
PROPERTY_PERSISTENT: 1,
},
Constants: {
PropertyType: { PERSISTENT: 1 },
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const mockProj = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
cb(mockCompoundAction)
return true
}),
}
const success = await saveSequenceLink(
mockProj as unknown as Project,
mockSeq as unknown as Sequence,
sampleLink,
)
expect(success).toBe(true)
expect(mockProps.createSetValueAction).toHaveBeenCalledWith(
LINK_STORAGE_PROP_KEY,
JSON.stringify(sampleLink),
1,
)
expect(mockCompoundAction.addAction).toHaveBeenCalledWith({ id: 'action-set' })
})
it('clears persistent property on removeSequenceLink', async () => {
const mockCompoundAction = { addAction: vi.fn() }
const mockProps = {
createClearValueAction: vi.fn().mockReturnValue({ id: 'action-clear' }),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const mockProj = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
cb(mockCompoundAction)
return true
}),
}
const success = await removeSequenceLink(
mockProj as unknown as Project,
mockSeq as unknown as Sequence,
)
expect(success).toBe(true)
expect(mockProps.createClearValueAction).toHaveBeenCalledWith(LINK_STORAGE_PROP_KEY)
})
it('removes synced markers matching syncedMarkerGuids on removeSequenceLink, preserving manual markers', async () => {
const mockCompoundAction = { addAction: vi.fn() }
const mockProps = {
getValue: vi.fn().mockReturnValue(
JSON.stringify({
...sampleLink,
syncedMarkerGuids: ['synced-marker-1', 'synced-marker-2'],
}),
),
createClearValueAction: vi.fn().mockReturnValue({ id: 'action-clear' }),
}
const mockMarker1 = {
guid: 'synced-marker-1',
name: 'Director (edited)',
comments: 'Edited comment',
}
const mockMarker2 = { guid: 'synced-marker-2', name: 'Producer', comments: 'Another comment' }
const mockManualMarker = {
guid: 'manual-user-marker',
name: 'Editor Note',
comments: 'Manual marker',
}
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([mockMarker1, mockManualMarker, mockMarker2]),
createRemoveMarkerAction: vi.fn().mockImplementation((marker) => ({
type: 'remove-marker',
guid: marker.guid,
})),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
},
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const mockProj = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
cb(mockCompoundAction)
return true
}),
}
const success = await removeSequenceLink(
mockProj as unknown as Project,
mockSeq as unknown as Sequence,
)
expect(success).toBe(true)
// Only synced-marker-1 and synced-marker-2 should be removed; manual-user-marker must NOT be removed
expect(mockSeqMarkers.createRemoveMarkerAction).toHaveBeenCalledTimes(2)
expect(mockSeqMarkers.createRemoveMarkerAction).toHaveBeenCalledWith(mockMarker1)
expect(mockSeqMarkers.createRemoveMarkerAction).toHaveBeenCalledWith(mockMarker2)
expect(mockSeqMarkers.createRemoveMarkerAction).not.toHaveBeenCalledWith(mockManualMarker)
expect(mockCompoundAction.addAction).toHaveBeenCalledWith({
type: 'remove-marker',
guid: 'synced-marker-1',
})
expect(mockCompoundAction.addAction).toHaveBeenCalledWith({
type: 'remove-marker',
guid: 'synced-marker-2',
})
expect(mockProps.createClearValueAction).toHaveBeenCalledWith(LINK_STORAGE_PROP_KEY)
})
it('removes markers by comment matching fallback when syncedMarkerGuids is empty', async () => {
localStorage.setItem('shumai_uxp_endpoint', 'https://shumai.example.com')
localStorage.setItem('shumai_uxp_api_key', 'test-api-key')
vi.spyOn(commentUtils, 'fetchAssetComments').mockResolvedValue([
{
id: 'comm-1',
creator: {
id: 'u1',
name: 'Director',
} as unknown as import('@shumai/dtos').CommentInfo['creator'],
message: 'Please trim this scene',
} as unknown as import('@shumai/dtos').CommentInfo,
])
const mockCompoundAction = { addAction: vi.fn() }
const mockProps = {
getValue: vi.fn().mockReturnValue(
JSON.stringify({
...sampleLink,
syncedMarkerGuids: [],
}),
),
createClearValueAction: vi.fn().mockReturnValue({ id: 'action-clear' }),
}
const mockLegacyShumaiMarker = {
guid: 'legacy-guid-1',
getName: () => 'Director',
getComments: () => 'Please trim this scene',
}
const mockManualMarker = {
guid: 'manual-guid-2',
getName: () => 'Editor',
getComments: () => 'My own note',
}
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([mockLegacyShumaiMarker, mockManualMarker]),
createRemoveMarkerAction: vi.fn().mockImplementation((marker) => ({
type: 'remove-marker',
guid: marker.guid,
})),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
},
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const mockProj = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
cb(mockCompoundAction)
return true
}),
}
const success = await removeSequenceLink(
mockProj as unknown as Project,
mockSeq as unknown as Sequence,
)
expect(success).toBe(true)
expect(mockSeqMarkers.createRemoveMarkerAction).toHaveBeenCalledWith(mockLegacyShumaiMarker)
expect(mockSeqMarkers.createRemoveMarkerAction).not.toHaveBeenCalledWith(mockManualMarker)
})
it('attempts individual marker removals if compound batch remove returns false', async () => {
const mockCompoundAction = { addAction: vi.fn() }
const mockProps = {
getValue: vi.fn().mockReturnValue(
JSON.stringify({
...sampleLink,
syncedMarkerGuids: ['synced-1'],
}),
),
createClearValueAction: vi.fn().mockReturnValue({ id: 'action-clear' }),
}
const mockMarker = { guid: 'synced-1' }
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([mockMarker]),
createRemoveMarkerAction: vi.fn().mockReturnValue({ type: 'remove-marker' }),
}
const mockPpro = {
Properties: {
getProperties: vi.fn().mockResolvedValue(mockProps),
},
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
let txCount = 0
const mockProj = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
txCount++
cb(mockCompoundAction)
if (txCount === 1) return false // batch failed
return true // individual succeeded
}),
}
const mockSeq = { guid: 'seq-guid-1' }
const success = await removeSequenceLink(
mockProj as unknown as Project,
mockSeq as unknown as Sequence,
)
expect(success).toBe(true)
expect(txCount).toBeGreaterThanOrEqual(2)
})
it('skips fallback comment fetch if link endpoint does not match current session endpoint', async () => {
localStorage.setItem('shumai_uxp_endpoint', 'https://staging.shumai.one')
localStorage.setItem('shumai_uxp_api_key', 'test-key')
const fetchCommentsSpy = vi.spyOn(commentUtils, 'fetchAssetComments')
const mockSeq = {
guid: 'seq-diff-endpoint',
name: 'Diff Endpoint Seq',
}
const mockProj = {
guid: 'proj-diff',
lockedAccess: (fn: () => void) => fn(),
executeTransaction: () => true,
}
const linkFromLocal: LinkedSequenceAsset = {
...sampleLink,
sequenceGuid: 'seq-diff-endpoint',
endpoint: 'http://localhost:3000',
syncedMarkerGuids: [], // Trigger fallback
}
saveSequenceLinkToCache(linkFromLocal, 'proj-diff')
await removeSequenceLink(mockProj as unknown as Project, mockSeq as unknown as Sequence)
expect(fetchCommentsSpy).not.toHaveBeenCalled()
})
})
describe('getAllLinkedSequences', () => {
it('does not leak cached links across projects when a project has an empty sequence list', async () => {
saveSequenceLinkToCache(sampleLink, 'proj-A')
const defaultLink: LinkedSequenceAsset = {
...sampleLink,
sequenceGuid: 'seq-default',
sequenceName: 'Default Seq',
}
saveSequenceLinkToCache(defaultLink, null)
const mockProjB = {
guid: 'proj-B',
getSequences: vi.fn().mockResolvedValue([]),
}
const results = await getAllLinkedSequences(mockProjB as unknown as Project, [])
expect(results).toEqual([])
})
it('restores cached link only if the sequence actually exists in the project', async () => {
saveSequenceLinkToCache(sampleLink, 'proj-A')
const mockSeq1 = { guid: 'seq-guid-1' }
const mockSeq2 = { guid: 'seq-guid-2' }
const mockProjA = {
guid: 'proj-A',
getSequences: vi.fn().mockResolvedValue([mockSeq1]),
}
const results = await getAllLinkedSequences(mockProjA as unknown as Project, [
mockSeq1 as unknown as Sequence,
])
expect(results).toHaveLength(1)
expect(results[0].sequenceGuid).toBe('seq-guid-1')
const resultsSeq2 = await getAllLinkedSequences(mockProjA as unknown as Project, [
mockSeq2 as unknown as Sequence,
])
expect(resultsSeq2).toHaveLength(0)
})
})
describe('normalizeGuid', () => {
it('normalizes GUIDs with uppercase, braces, whitespace, and objects', () => {
expect(normalizeGuid('{1234-ABCD-5678}')).toBe('1234-abcd-5678')
expect(normalizeGuid(' ABC-DEF ')).toBe('abc-def')
expect(normalizeGuid({ toString: () => '{Guid-Obj}' })).toBe('guid-obj')
expect(normalizeGuid(null)).toBe('')
expect(normalizeGuid(undefined)).toBe('')
})
})
})
@@ -0,0 +1,472 @@
import type { Marker, Project, Sequence } from '@adobe/premierepro'
import { getPremiereModule } from './premiere'
import type { LinkedSequenceAsset } from '../types/link'
import { getStoredCredentials } from './storage'
import { fetchAssetComments, formatCommentBody } from './commentUtils'
import { isSameEndpoint } from '../utils/url'
export const LINK_STORAGE_PROP_KEY = 'shumai_linked_asset'
const STORAGE_PREFIX = '@shumai/premiere-uxp:project-links'
/**
* Normalizes a GUID or string identifier by removing curly braces,
* trimming whitespace, and converting to lower case for reliable comparison.
*/
export function normalizeGuid(guid: unknown): string {
if (!guid) return ''
const str =
typeof guid === 'string'
? guid
: typeof (guid as { toString?: () => string }).toString === 'function'
? (guid as { toString: () => string }).toString()
: String(guid)
return str.trim().toLowerCase().replace(/[{}]/g, '')
}
function getStorageKey(projectGuid?: string | null): string {
return `${STORAGE_PREFIX}:${projectGuid ? normalizeGuid(projectGuid) : 'default'}`
}
/**
* Reads all cached sequence links for a project from localStorage.
* If projectGuid is omitted or null, aggregates across all project keys in localStorage.
*/
export function getAllSequenceLinksFromCache(projectGuid?: string | null): LinkedSequenceAsset[] {
if (typeof localStorage === 'undefined') return []
try {
const normProj = projectGuid ? normalizeGuid(projectGuid) : null
if (normProj) {
const raw = localStorage.getItem(getStorageKey(normProj))
if (raw) {
const parsed = JSON.parse(raw)
if (Array.isArray(parsed)) return parsed
if (typeof parsed === 'object' && parsed !== null) {
return Object.values(parsed)
}
}
return []
}
// When projectGuid is not provided, aggregate all cached sequence links
const results: LinkedSequenceAsset[] = []
const seenGuids = new Set<string>()
// Check default key
const defaultRaw = localStorage.getItem(getStorageKey(null))
if (defaultRaw) {
try {
const parsed = JSON.parse(defaultRaw)
const items: LinkedSequenceAsset[] = Array.isArray(parsed)
? parsed
: typeof parsed === 'object' && parsed !== null
? Object.values(parsed)
: []
for (const item of items) {
const normSeq = normalizeGuid(item.sequenceGuid)
if (normSeq && !seenGuids.has(normSeq)) {
seenGuids.add(normSeq)
results.push(item)
}
}
} catch {
// Ignore JSON error
}
}
// Scan all keys matching STORAGE_PREFIX in localStorage
if (typeof localStorage.length === 'number') {
for (let i = 0; i < localStorage.length; i++) {
const key = typeof localStorage.key === 'function' ? localStorage.key(i) : null
if (key && key.startsWith(STORAGE_PREFIX)) {
const raw = localStorage.getItem(key)
if (raw) {
try {
const parsed = JSON.parse(raw)
const items: LinkedSequenceAsset[] = Array.isArray(parsed)
? parsed
: typeof parsed === 'object' && parsed !== null
? Object.values(parsed)
: []
for (const item of items) {
const normSeq = normalizeGuid(item.sequenceGuid)
if (normSeq && !seenGuids.has(normSeq)) {
seenGuids.add(normSeq)
results.push(item)
}
}
} catch {
// Ignore corrupted item
}
}
}
}
}
return results
} catch (err) {
console.warn('[linkStorage] Failed to read cached links from localStorage:', err)
return []
}
}
/**
* Gets a cached sequence link by sequence GUID from localStorage.
*/
export function getSequenceLinkFromCache(
sequenceGuid: string,
projectGuid?: string | null,
): LinkedSequenceAsset | null {
const normSeq = normalizeGuid(sequenceGuid)
const all = getAllSequenceLinksFromCache(projectGuid)
return all.find((item) => normalizeGuid(item.sequenceGuid) === normSeq) || null
}
/**
* Saves a sequence link in the local cache.
*/
export function saveSequenceLinkToCache(
linkData: LinkedSequenceAsset,
projectGuid?: string | null,
): void {
if (typeof localStorage === 'undefined') return
try {
const normSeq = normalizeGuid(linkData.sequenceGuid)
const normalizedData: LinkedSequenceAsset = {
...linkData,
sequenceGuid: normSeq,
...(linkData.syncedMarkerGuids != null
? { syncedMarkerGuids: linkData.syncedMarkerGuids.map(normalizeGuid).filter(Boolean) }
: {}),
}
if (projectGuid) {
const all = getAllSequenceLinksFromCache(projectGuid).filter(
(item) => normalizeGuid(item.sequenceGuid) !== normSeq,
)
all.push(normalizedData)
localStorage.setItem(getStorageKey(projectGuid), JSON.stringify(all))
}
// Always also update default key so it's accessible when projectGuid is unknown
const defaultAll = getAllSequenceLinksFromCache(null).filter(
(item) => normalizeGuid(item.sequenceGuid) !== normSeq,
)
defaultAll.push(normalizedData)
localStorage.setItem(getStorageKey(null), JSON.stringify(defaultAll))
} catch (err) {
console.warn('[linkStorage] Failed to save link to localStorage:', err)
}
}
/**
* Removes a sequence link from the local cache.
*/
export function removeSequenceLinkFromCache(
sequenceGuid: string,
projectGuid?: string | null,
): void {
if (typeof localStorage === 'undefined') return
try {
const normSeq = normalizeGuid(sequenceGuid)
if (projectGuid) {
const all = getAllSequenceLinksFromCache(projectGuid).filter(
(item) => normalizeGuid(item.sequenceGuid) !== normSeq,
)
localStorage.setItem(getStorageKey(projectGuid), JSON.stringify(all))
}
const defaultAll = getAllSequenceLinksFromCache(null).filter(
(item) => normalizeGuid(item.sequenceGuid) !== normSeq,
)
localStorage.setItem(getStorageKey(null), JSON.stringify(defaultAll))
// Also remove from any other keys matching STORAGE_PREFIX
if (typeof localStorage.length === 'number') {
for (let i = 0; i < localStorage.length; i++) {
const key = typeof localStorage.key === 'function' ? localStorage.key(i) : null
if (key && key.startsWith(STORAGE_PREFIX)) {
const raw = localStorage.getItem(key)
if (raw) {
try {
const parsed = JSON.parse(raw)
if (Array.isArray(parsed)) {
const filtered = parsed.filter(
(item) => normalizeGuid(item.sequenceGuid) !== normSeq,
)
localStorage.setItem(key, JSON.stringify(filtered))
}
} catch {
// Ignore
}
}
}
}
}
} catch (err) {
console.warn('[linkStorage] Failed to remove link from localStorage:', err)
}
}
/**
* Retrieves the persistent link metadata from a sequence's properties.
*/
export async function getSequenceLink(
sequence: Sequence,
project?: Project | null,
): Promise<LinkedSequenceAsset | null> {
const ppro = getPremiereModule()
const seqGuidStr = normalizeGuid(sequence.guid)
const prGuidStr = project?.guid ? normalizeGuid(project.guid) : null
// Check persistent sequence properties in Premiere
if (ppro?.Properties) {
try {
const properties = await ppro.Properties.getProperties(sequence)
const raw = properties.getValue(LINK_STORAGE_PROP_KEY)
if (raw) {
const parsed = JSON.parse(raw) as LinkedSequenceAsset
// Synchronize with cache
saveSequenceLinkToCache(parsed, prGuidStr)
return parsed
}
} catch (err) {
// Property might not exist or failed to load
console.debug('[linkStorage] No persistent property found or failed:', err)
}
}
// Fallback to local cache if sequence property was not available
return getSequenceLinkFromCache(seqGuidStr, prGuidStr)
}
/**
* Retrieves all linked sequence assets across a project.
*/
export async function getAllLinkedSequences(
project: Project,
allSequences?: Sequence[],
): Promise<LinkedSequenceAsset[]> {
const prGuidStr = project.guid ? normalizeGuid(project.guid) : null
const seqs = allSequences || (await project.getSequences()) || []
const results: LinkedSequenceAsset[] = []
const checkedGuids = new Set<string>()
for (const seq of seqs) {
const seqGuid = normalizeGuid(seq.guid)
if (seqGuid) checkedGuids.add(seqGuid)
const link = await getSequenceLink(seq, project)
if (link) {
results.push(link)
}
}
// Also check cache for any items matching known sequences
const cached = getAllSequenceLinksFromCache(prGuidStr)
for (const item of cached) {
const normItemSeq = normalizeGuid(item.sequenceGuid)
if (!results.some((r) => normalizeGuid(r.sequenceGuid) === normItemSeq)) {
if (checkedGuids.has(normItemSeq)) {
results.push(item)
}
}
}
return results
}
/**
* Saves the link metadata persistently on the sequence and in the cache.
*/
export async function saveSequenceLink(
project: Project,
sequence: Sequence,
linkData: LinkedSequenceAsset,
): Promise<boolean> {
const ppro = getPremiereModule()
const prGuidStr = project.guid ? normalizeGuid(project.guid) : null
// Always update cache first
saveSequenceLinkToCache(linkData, prGuidStr)
if (!ppro?.Properties) {
return true
}
try {
const properties = await ppro.Properties.getProperties(sequence)
const persistentType =
ppro.Constants?.PropertyType?.PERSISTENT ?? ppro.Properties.PROPERTY_PERSISTENT ?? 0
let success = false
project.lockedAccess(() => {
success = project.executeTransaction((compoundAction) => {
const setValAction = properties.createSetValueAction(
LINK_STORAGE_PROP_KEY,
JSON.stringify(linkData),
persistentType,
)
compoundAction.addAction(setValAction)
}, 'Save Shumai Link')
})
return success
} catch (err) {
console.warn('[linkStorage] Failed to set sequence persistent property:', err)
return true // Local cache succeeded
}
}
/**
* Removes the persistent link metadata from the sequence and cache,
* and deletes any markers that were synced from Shumai (matching Frame.io behavior).
*/
export async function removeSequenceLink(project: Project, sequence: Sequence): Promise<boolean> {
const ppro = getPremiereModule()
const seqGuidStr = normalizeGuid(sequence.guid)
const prGuidStr = project.guid ? normalizeGuid(project.guid) : null
console.log('[linkStorage] removeSequenceLink called for sequence:', sequence.name || seqGuidStr)
// Retrieve link metadata before clearing, to identify synced marker GUIDs
let linkData = await getSequenceLink(sequence, project)
if (!linkData) {
const cached = getAllSequenceLinksFromCache(prGuidStr)
linkData = cached.find((item) => normalizeGuid(item.sequenceGuid) === seqGuidStr) || null
}
console.log(
'[linkStorage] Retrieved linkData:',
linkData ? { assetId: linkData.assetId, guidsCount: linkData.syncedMarkerGuids?.length } : null,
)
// Remove from cache
removeSequenceLinkFromCache(seqGuidStr, prGuidStr)
// Remove synced markers from the sequence timeline
if (ppro?.Markers) {
try {
const sequenceMarkers = await ppro.Markers.getMarkers(sequence)
const allMarkers = sequenceMarkers.getMarkers() || []
console.log('[linkStorage] Found', allMarkers.length, 'markers on sequence timeline')
const targetGuids = new Set(
(linkData?.syncedMarkerGuids || []).map(normalizeGuid).filter(Boolean),
)
console.log('[linkStorage] targetGuids count:', targetGuids.size)
const markersToRemove: Marker[] = []
// 1. Match markers by GUID
if (targetGuids.size > 0) {
for (const m of allMarkers) {
const g = normalizeGuid(m.guid)
if (g && targetGuids.has(g)) {
markersToRemove.push(m)
}
}
}
// 2. Fallback: If targetGuids was empty/missing or didn't find markers, match by asset comments
if (markersToRemove.length === 0 && linkData?.assetId) {
console.log(
'[linkStorage] Fallback: attempting comment-based marker identification for asset:',
linkData.assetId,
)
try {
const creds = getStoredCredentials()
const canFetchComments =
creds?.endpoint &&
creds?.apiKey &&
(!linkData.endpoint || isSameEndpoint(linkData.endpoint, creds.endpoint))
if (canFetchComments) {
const comments = await fetchAssetComments(
creds.endpoint,
creds.apiKey,
linkData.assetId,
)
for (const comm of comments) {
const commBody = formatCommentBody(comm)
const commAuthor = comm.creator?.name || 'Comment'
for (const m of allMarkers) {
if (markersToRemove.includes(m)) continue
try {
const mName = m.getName()
const mComments = m.getComments()
if (
(mName === commAuthor && mComments === commBody) ||
(mComments && comm.message && mComments.includes(comm.message))
) {
markersToRemove.push(m)
break
}
} catch {
// ignore
}
}
}
}
} catch (err) {
console.warn('[linkStorage] Fallback comment fetch failed:', err)
}
}
console.log('[linkStorage] Total markers to remove:', markersToRemove.length)
if (markersToRemove.length > 0) {
let removeSuccess = false
try {
project.lockedAccess(() => {
removeSuccess = project.executeTransaction((compoundAction) => {
for (const marker of markersToRemove) {
const removeAction = sequenceMarkers.createRemoveMarkerAction(marker)
compoundAction.addAction(removeAction)
}
}, 'Remove Shumai Synced Markers')
})
} catch (err) {
console.error('[linkStorage] executeTransaction batch remove failed:', err)
}
console.log('[linkStorage] Batch remove result:', removeSuccess)
// If batch compound action did not succeed, attempt individual removals
if (!removeSuccess) {
console.warn('[linkStorage] Batch remove returned false, attempting individual removals')
for (const marker of markersToRemove) {
try {
project.lockedAccess(() => {
project.executeTransaction((compoundAction) => {
const removeAction = sequenceMarkers.createRemoveMarkerAction(marker)
compoundAction.addAction(removeAction)
}, 'Remove Shumai Synced Marker')
})
} catch (indErr) {
console.warn('[linkStorage] Failed individual remove:', indErr)
}
}
}
}
} catch (err) {
console.warn('[linkStorage] Failed to remove synced markers from sequence:', err)
}
}
if (!ppro?.Properties) {
return true
}
try {
const properties = await ppro.Properties.getProperties(sequence)
let success = false
project.lockedAccess(() => {
success = project.executeTransaction((compoundAction) => {
const clearAction = properties.createClearValueAction(LINK_STORAGE_PROP_KEY)
compoundAction.addAction(clearAction)
}, 'Unlink Shumai Asset')
})
console.log('[linkStorage] Clear property result:', success)
return success
} catch (err) {
console.warn('[linkStorage] Failed to clear sequence persistent property:', err)
return true // Cache was cleared
}
}
@@ -0,0 +1,405 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import { formatCommentBody, syncCommentsToSequence } from './markers'
import type { Project, Sequence } from '@adobe/premierepro'
import type { CommentInfo } from '@shumai/dtos'
import type { LinkedSequenceAsset } from '../types/link'
const localStorageMock = (() => {
let store: Record<string, string> = {}
return {
getItem: (key: string) => store[key] || null,
setItem: (key: string, value: string) => {
store[key] = value.toString()
},
removeItem: (key: string) => {
delete store[key]
},
clear: () => {
store = {}
},
}
})()
Object.defineProperty(globalThis, 'localStorage', {
value: localStorageMock,
configurable: true,
writable: true,
})
describe('markers service', () => {
beforeEach(() => {
localStorage.clear()
vi.restoreAllMocks()
// Reset global require
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).require
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).window
})
describe('formatCommentBody', () => {
it('formats simple comment without replies', () => {
const comment: Partial<CommentInfo> = {
message: 'This is a test comment',
replies: [],
}
expect(formatCommentBody(comment as CommentInfo)).toBe('This is a test comment')
})
it('appends formatted replies beneath message', () => {
const comment: Partial<CommentInfo> = {
message: 'Original cut feedback',
replies: [
{
creator: { id: 'u2', name: 'Alice' },
message: 'Fixed in v2',
} as unknown as CommentInfo,
{
creator: { id: 'u3', name: 'Bob' },
message: 'Looks great now',
} as unknown as CommentInfo,
],
}
const formatted = formatCommentBody(comment as CommentInfo)
expect(formatted).toContain('Original cut feedback')
expect(formatted).toContain('--- Replies ---')
expect(formatted).toContain('Alice: Fixed in v2')
expect(formatted).toContain('Bob: Looks great now')
})
})
describe('syncCommentsToSequence', () => {
const existingLink: LinkedSequenceAsset = {
sequenceGuid: 'seq-guid-1',
sequenceName: 'Seq 1',
assetId: 'asset-1',
assetName: 'test.mp4',
syncedCommentIds: ['comm-1'],
lastSyncAt: 1000,
totalCommentsSynced: 1,
}
it('returns without creating markers if no new comments exist', async () => {
const comments: Partial<CommentInfo>[] = [
{ id: 'comm-1', second: 10, message: 'Already synced' },
]
const mockProject = {
guid: 'proj-1',
lockedAccess: vi.fn(),
executeTransaction: vi.fn(),
}
const mockSeq = { guid: 'seq-guid-1' }
const result = await syncCommentsToSequence(
mockProject as unknown as Project,
mockSeq as unknown as Sequence,
comments as CommentInfo[],
existingLink,
)
expect(result.addedCount).toBe(0)
expect(result.updatedLink.syncedCommentIds).toEqual(['comm-1'])
expect(mockProject.executeTransaction).not.toHaveBeenCalled()
})
it('creates markers for new comments, placing non-timestamped comments at time 0 (zeroPoint)', async () => {
const mockCompoundAction = { addAction: vi.fn() }
let callCount = 0
const mockSeqMarkers = {
getMarkers: vi.fn().mockImplementation(() => {
callCount++
if (callCount === 1) {
return [{ guid: 'old-guid-1' }]
}
return [{ guid: 'old-guid-1' }, { guid: 'marker-guid-2' }, { guid: 'marker-guid-3' }]
}),
createAddMarkerAction: vi.fn().mockImplementation((name, type, time, dur, comment) => {
return { name, type, time, dur, comment }
}),
}
const mockPpro = {
Marker: { MARKER_TYPE_COMMENT: 'CommentMarkerType' },
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
TickTime: {
TIME_ZERO: { ticks: '0' },
createWithSeconds: vi.fn((sec) => ({ seconds: sec })),
},
Properties: {
getProperties: vi.fn().mockResolvedValue({
createSetValueAction: vi.fn().mockReturnValue({}),
}),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const comments: Partial<CommentInfo>[] = [
{ id: 'comm-1', second: 10, message: 'Already synced' },
{
id: 'comm-2',
second: 15.5,
message: 'New timestamped comment',
creator: { id: 'u1', name: 'Director' } as unknown as CommentInfo['creator'],
replies: [],
},
{
id: 'comm-3',
second: null,
message: 'General comment without timestamp',
creator: { id: 'u2', name: 'Producer' } as unknown as CommentInfo['creator'],
replies: [],
},
]
const mockProject = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn((cb) => {
cb(mockCompoundAction)
return true
}),
}
const mockSeq = {
guid: 'seq-guid-1',
getZeroPoint: vi.fn().mockResolvedValue({ seconds: 3600 }), // 1hr timecode start
}
const result = await syncCommentsToSequence(
mockProject as unknown as Project,
mockSeq as unknown as Sequence,
comments as CommentInfo[],
existingLink,
)
expect(result.addedCount).toBe(2)
expect(result.updatedLink.syncedCommentIds).toEqual(['comm-1', 'comm-2', 'comm-3'])
expect(result.updatedLink.syncedMarkerGuids).toEqual(['marker-guid-2', 'marker-guid-3'])
expect(result.updatedLink.totalCommentsSynced).toBe(3)
// Time should be offset by zeroPoint (3600 + 15.5 = 3615.5 for comm-2, 3600 + 0 = 3600 for comm-3)
expect(mockPpro.TickTime.createWithSeconds).toHaveBeenCalledWith(3615.5)
expect(mockPpro.TickTime.createWithSeconds).toHaveBeenCalledWith(3600)
expect(mockSeqMarkers.createAddMarkerAction).toHaveBeenCalledWith(
'Director',
'CommentMarkerType',
{ seconds: 3615.5 },
mockPpro.TickTime.TIME_ZERO,
'New timestamped comment',
)
expect(mockSeqMarkers.createAddMarkerAction).toHaveBeenCalledWith(
'Producer',
'CommentMarkerType',
{ seconds: 3600 },
mockPpro.TickTime.TIME_ZERO,
'General comment without timestamp',
)
expect(mockSeqMarkers.createAddMarkerAction).toHaveBeenCalledTimes(2)
expect(mockCompoundAction.addAction).toHaveBeenCalled()
})
it('backfills missing marker GUIDs from sequence when syncedMarkerGuids is incomplete', async () => {
const existingLink: LinkedSequenceAsset = {
sequenceGuid: 'seq-guid-1',
sequenceName: 'Sequence 01',
assetId: 'asset-1',
assetName: 'video.mp4',
syncedCommentIds: ['comm-1'],
syncedMarkerGuids: [], // missing GUIDs from previous sync
totalCommentsSynced: 1,
lastSyncAt: 1000,
}
const mockLegacyMarker = {
guid: '{LEGACY-MARKER-GUID-1}',
getName: () => 'Director',
getComments: () => 'Existing comment message',
}
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([mockLegacyMarker]),
createAddMarkerAction: vi.fn(),
}
const mockPpro = {
Marker: { MARKER_TYPE_COMMENT: 'CommentMarkerType' },
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
TickTime: {
TIME_ZERO: { ticks: '0' },
createWithSeconds: vi.fn((sec) => ({ seconds: sec })),
},
Properties: {
getProperties: vi.fn().mockResolvedValue({
createSetValueAction: vi.fn().mockReturnValue({}),
}),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const comments: Partial<CommentInfo>[] = [
{
id: 'comm-1',
second: 10,
message: 'Existing comment message',
creator: { id: 'u1', name: 'Director' } as unknown as CommentInfo['creator'],
replies: [],
},
]
const mockProject = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn(),
}
const mockSeq = {
guid: 'seq-guid-1',
getZeroPoint: vi.fn().mockResolvedValue({ seconds: 0 }),
}
const result = await syncCommentsToSequence(
mockProject as unknown as Project,
mockSeq as unknown as Sequence,
comments as CommentInfo[],
existingLink,
)
expect(result.addedCount).toBe(0)
expect(result.updatedLink.syncedMarkerGuids).toEqual(['legacy-marker-guid-1'])
expect(mockSeqMarkers.createAddMarkerAction).not.toHaveBeenCalled()
})
it('does not advance synced comments when executeTransaction returns false', async () => {
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([]),
createAddMarkerAction: vi.fn().mockReturnValue({}),
}
const mockPpro = {
Marker: { MARKER_TYPE_COMMENT: 'CommentMarkerType' },
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
TickTime: {
TIME_ZERO: { ticks: '0' },
createWithSeconds: vi.fn((sec) => ({ seconds: sec })),
},
Properties: {
getProperties: vi.fn().mockResolvedValue({
createSetValueAction: vi.fn().mockReturnValue({}),
}),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const comments: Partial<CommentInfo>[] = [
{ id: 'comm-1', second: 10, message: 'Already synced' },
{ id: 'comm-2', second: 20, message: 'New comment' },
]
const mockProject = {
guid: 'proj-1',
lockedAccess: vi.fn((cb) => cb()),
executeTransaction: vi.fn().mockReturnValue(false),
}
const mockSeq = {
guid: 'seq-guid-1',
getZeroPoint: vi.fn().mockResolvedValue({ seconds: 0 }),
}
const result = await syncCommentsToSequence(
mockProject as unknown as Project,
mockSeq as unknown as Sequence,
comments as CommentInfo[],
existingLink,
)
expect(result.addedCount).toBe(0)
expect(result.updatedLink.syncedCommentIds).toEqual(['comm-1'])
expect(result.updatedLink.totalCommentsSynced).toBe(1)
})
it('does not advance synced comments when executeTransaction throws an error', async () => {
const mockSeqMarkers = {
getMarkers: vi.fn().mockReturnValue([]),
createAddMarkerAction: vi.fn().mockReturnValue({}),
}
const mockPpro = {
Marker: { MARKER_TYPE_COMMENT: 'CommentMarkerType' },
Markers: {
getMarkers: vi.fn().mockResolvedValue(mockSeqMarkers),
},
TickTime: {
TIME_ZERO: { ticks: '0' },
createWithSeconds: vi.fn((sec) => ({ seconds: sec })),
},
Properties: {
getProperties: vi.fn().mockResolvedValue({
createSetValueAction: vi.fn().mockReturnValue({}),
}),
},
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
const comments: Partial<CommentInfo>[] = [
{ id: 'comm-1', second: 10, message: 'Already synced' },
{ id: 'comm-2', second: 20, message: 'New comment' },
]
const mockProject = {
guid: 'proj-1',
lockedAccess: vi.fn(() => {
throw new Error('Transaction execution crashed')
}),
executeTransaction: vi.fn(),
}
const mockSeq = {
guid: 'seq-guid-1',
getZeroPoint: vi.fn().mockResolvedValue({ seconds: 0 }),
}
const result = await syncCommentsToSequence(
mockProject as unknown as Project,
mockSeq as unknown as Sequence,
comments as CommentInfo[],
existingLink,
)
expect(result.addedCount).toBe(0)
expect(result.updatedLink.syncedCommentIds).toEqual(['comm-1'])
expect(result.updatedLink.totalCommentsSynced).toBe(1)
})
})
})
+179
View File
@@ -0,0 +1,179 @@
import type { Project, Sequence } from '@adobe/premierepro'
import { getPremiereModule } from './premiere'
import type { LinkedSequenceAsset } from '../types/link'
import { normalizeGuid, saveSequenceLink } from './linkStorage'
import type { CommentInfo } from '@shumai/dtos'
import { fetchAssetComments, formatCommentBody } from './commentUtils'
export { fetchAssetComments, formatCommentBody }
export interface SyncCommentsResult {
updatedLink: LinkedSequenceAsset
addedCount: number
}
/**
* Synchronizes new Shumai comments to a Premiere Pro sequence as markers.
* Comments without timestamps (`second == null`) default to time 0 (sequence start),
* matching Frame.io convention. Newly created marker GUIDs are captured and stored
* so they can be accurately removed when the sequence is unlinked.
*/
export async function syncCommentsToSequence(
project: Project,
sequence: Sequence,
comments: CommentInfo[],
existingLink: LinkedSequenceAsset,
): Promise<SyncCommentsResult> {
const ppro = getPremiereModule()
const now = Date.now()
// Filter comments that have not been synced yet; non-timestamped comments default to time 0
const alreadySyncedSet = new Set(existingLink.syncedCommentIds)
const newComments = comments.filter((c) => !alreadySyncedSet.has(c.id))
const currentMarkerGuids = (existingLink.syncedMarkerGuids || [])
.map(normalizeGuid)
.filter(Boolean)
const needsGuidBackfill =
currentMarkerGuids.length < (existingLink.syncedCommentIds?.length || 0) &&
ppro?.Markers != null
if (newComments.length === 0 && !needsGuidBackfill) {
const updatedLink: LinkedSequenceAsset = {
...existingLink,
lastSyncAt: now,
}
await saveSequenceLink(project, sequence, updatedLink)
return { updatedLink, addedCount: 0 }
}
if (!ppro?.Markers || !ppro?.TickTime) {
console.warn('[markers] premierepro Markers or TickTime module not available')
return { updatedLink: existingLink, addedCount: 0 }
}
const newMarkerGuids: string[] = []
try {
const sequenceMarkers = await ppro.Markers.getMarkers(sequence)
let zeroPointSeconds = 0
try {
const zeroPoint = await sequence.getZeroPoint()
if (zeroPoint && typeof zeroPoint.seconds === 'number') {
zeroPointSeconds = zeroPoint.seconds
}
} catch {
// zeroPoint defaults to 0
}
// Capture existing marker GUIDs before adding new markers
let beforeGuids = new Set<string>()
try {
const beforeMarkers = sequenceMarkers.getMarkers() || []
beforeGuids = new Set(beforeMarkers.map((m) => normalizeGuid(m.guid)).filter(Boolean))
console.log('[markers] Existing markers before sync:', beforeMarkers.length)
} catch (err) {
console.warn('[markers] Could not get existing markers before sync:', err)
}
if (newComments.length > 0) {
let txSuccess = false
project.lockedAccess(() => {
txSuccess =
project.executeTransaction((compoundAction) => {
for (const comment of newComments) {
const markerSeconds = zeroPointSeconds + (comment.second ?? 0)
const startTime = ppro.TickTime.createWithSeconds(markerSeconds)
const duration = ppro.TickTime.TIME_ZERO
const markerName = comment.creator?.name || 'Comment'
const markerText = formatCommentBody(comment)
const addMarkerAction = sequenceMarkers.createAddMarkerAction(
markerName,
ppro.Marker.MARKER_TYPE_COMMENT,
startTime,
duration,
markerText,
)
compoundAction.addAction(addMarkerAction)
}
}, 'Sync Shumai Comments') === true
})
console.log('[markers] executeTransaction result:', txSuccess)
if (!txSuccess) {
console.warn('[markers] Failed to execute add markers transaction (returned false)')
return { updatedLink: existingLink, addedCount: 0 }
}
}
// Re-fetch fresh Markers object after transaction to ensure newly committed markers are seen
const freshSequenceMarkers = await ppro.Markers.getMarkers(sequence)
const afterMarkers = freshSequenceMarkers.getMarkers() || []
console.log('[markers] Markers after sync transaction:', afterMarkers.length)
// 1. Identify newly added markers by GUID difference
for (const m of afterMarkers) {
const guidStr = normalizeGuid(m.guid)
if (guidStr && !beforeGuids.has(guidStr) && !newMarkerGuids.includes(guidStr)) {
newMarkerGuids.push(guidStr)
}
}
// 2. Fallback / Backfill: Match any comment markers by content/author
const allExpectedComments = [...newComments]
if (needsGuidBackfill) {
const alreadySyncedComments = comments.filter((c) => alreadySyncedSet.has(c.id))
allExpectedComments.push(...alreadySyncedComments)
}
const currentKnownGuids = new Set([...currentMarkerGuids, ...newMarkerGuids])
for (const comment of allExpectedComments) {
const commentBody = formatCommentBody(comment)
const commentAuthor = comment.creator?.name || 'Comment'
for (const m of afterMarkers) {
const g = normalizeGuid(m.guid)
if (!g || currentKnownGuids.has(g)) continue
try {
const mName = m.getName()
const mComments = m.getComments()
if (
(mName === commentAuthor && mComments === commentBody) ||
(mComments && comment.message && mComments.includes(comment.message))
) {
newMarkerGuids.push(g)
currentKnownGuids.add(g)
break
}
} catch {
// ignore
}
}
}
console.log(
'[markers] Total newly captured/backfilled marker GUIDs:',
newMarkerGuids.length,
newMarkerGuids,
)
const updatedMarkerGuids = Array.from(
new Set([...currentMarkerGuids, ...newMarkerGuids.map(normalizeGuid)]),
)
const updatedLink: LinkedSequenceAsset = {
...existingLink,
syncedCommentIds: [...existingLink.syncedCommentIds, ...newComments.map((c) => c.id)],
syncedMarkerGuids: updatedMarkerGuids,
totalCommentsSynced: existingLink.totalCommentsSynced + newComments.length,
lastSyncAt: now,
}
await saveSequenceLink(project, sequence, updatedLink)
return { updatedLink, addedCount: newComments.length }
} catch (err) {
console.error('[markers] Failed to execute add markers transaction:', err)
return { updatedLink: existingLink, addedCount: 0 }
}
}
@@ -0,0 +1,248 @@
import { describe, it, expect, vi, beforeEach } from 'vitest'
import {
getActiveProject,
importFilesIntoProject,
promptSelectFolder,
promptSaveFile,
writeBinaryFile,
getPremiereModule,
getUxpModule,
} from './premiere'
import type { Project, Sequence } from '@adobe/premierepro'
describe('premiere service', () => {
beforeEach(() => {
vi.restoreAllMocks()
// Reset any global require mocks on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).require
// Reset window mock on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
delete (globalThis as any).window
})
describe('module getters', () => {
it('returns null when premierepro is not available', () => {
expect(getPremiereModule()).toBeNull()
})
it('returns null when uxp is not available', () => {
expect(getUxpModule()).toBeNull()
})
it('resolves premiere module from global require when present', () => {
const mockPpro = { Project: { getActiveProject: vi.fn() } }
// Mocking UXP window environment on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') return mockPpro
return null
}),
}
expect(getPremiereModule()).toBe(mockPpro)
})
})
describe('getActiveProject', () => {
it('returns null when module is missing', async () => {
const project = await getActiveProject()
expect(project).toBeNull()
})
it('returns active project when available', async () => {
const mockProject = { name: 'MyProject.prproj' }
// Mocking UXP window environment on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'premierepro') {
return {
Project: {
getActiveProject: vi.fn().mockResolvedValue(mockProject),
},
}
}
return null
}),
}
const project = await getActiveProject()
expect(project).toBe(mockProject)
})
})
describe('importFilesIntoProject', () => {
it('returns false when filePaths is empty', async () => {
const project = { importFiles: vi.fn() } as unknown as Project
const success = await importFilesIntoProject(project, [])
expect(success).toBe(false)
expect(project.importFiles).not.toHaveBeenCalled()
})
it('calls project.importFiles with suppressUI true', async () => {
const project = {
importFiles: vi.fn().mockResolvedValue(true),
} as unknown as Project
const success = await importFilesIntoProject(project, ['/path/to/video.mp4'])
expect(success).toBe(true)
expect(project.importFiles).toHaveBeenCalledWith(['/path/to/video.mp4'], true, null, false)
})
it('handles import error gracefully', async () => {
const project = {
importFiles: vi.fn().mockRejectedValue(new Error('Import failed in host')),
} as unknown as Project
const success = await importFilesIntoProject(project, ['/path/to/video.mp4'])
expect(success).toBe(false)
})
})
describe('promptSelectFolder', () => {
it('throws when UXP storage is unavailable', async () => {
await expect(promptSelectFolder()).rejects.toThrow('UXP storage')
})
it('delegates to uxp.storage.localFileSystem.getFolder', async () => {
const mockFolder: UxpFolderEntry = {
isFile: false,
isFolder: true,
name: 'Downloads',
nativePath: '/Users/test/Downloads',
createFile: vi.fn(),
getEntries: vi.fn().mockResolvedValue([]),
}
// Mocking UXP window environment on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'uxp') {
return {
storage: {
localFileSystem: {
getFolder: vi.fn().mockResolvedValue(mockFolder),
},
},
}
}
return null
}),
}
const folder = await promptSelectFolder()
expect(folder).toBe(mockFolder)
})
})
describe('promptSaveFile', () => {
it('throws when UXP storage is unavailable', async () => {
await expect(promptSaveFile('test.mp4')).rejects.toThrow('UXP storage')
})
it('delegates to uxp.storage.localFileSystem.getFileForSaving', async () => {
const mockFile: UxpFileEntry = {
isFile: true,
isFolder: false,
name: 'test.mp4',
nativePath: '/path/test.mp4',
write: vi.fn(),
}
// Mocking UXP window environment on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'uxp') {
return {
storage: {
localFileSystem: {
getFileForSaving: vi.fn().mockResolvedValue(mockFile),
},
},
}
}
return null
}),
}
const file = await promptSaveFile('test.mp4')
expect(file).toBe(mockFile)
})
})
describe('writeBinaryFile', () => {
it('calls file.write with binary format option', async () => {
const mockFile: UxpFileEntry = {
isFile: true,
isFolder: false,
name: 'test.mp4',
nativePath: '/path/test.mp4',
write: vi.fn().mockResolvedValue(undefined),
}
// Mocking UXP window environment on globalThis
// eslint-disable-next-line @typescript-eslint/no-explicit-any
;(globalThis as any).window = {
require: vi.fn().mockImplementation((name: string) => {
if (name === 'uxp') {
return {
storage: {
formats: { binary: 'binary-format-token' },
},
}
}
return null
}),
}
const dummyBuffer = new ArrayBuffer(16)
await writeBinaryFile(mockFile, dummyBuffer)
expect(mockFile.write).toHaveBeenCalledWith(dummyBuffer, { format: 'binary-format-token' })
})
})
describe('sequence functions', () => {
it('getActiveSequence returns active sequence from project', async () => {
const { getActiveSequence } = await import('./premiere')
const mockSeq = { name: 'Seq 1', guid: 'guid-1' }
const mockProject = {
getActiveSequence: vi.fn().mockResolvedValue(mockSeq),
}
const seq = await getActiveSequence(mockProject as unknown as Project)
expect(seq).toBe(mockSeq)
})
it('getAllSequences returns array of sequences', async () => {
const { getAllSequences } = await import('./premiere')
const mockSeq1 = { name: 'Seq 1', guid: 'guid-1' }
const mockSeq2 = { name: 'Seq 2', guid: 'guid-2' }
const mockProject = {
getSequences: vi.fn().mockResolvedValue([mockSeq1, mockSeq2]),
}
const seqs = await getAllSequences(mockProject as unknown as Project)
expect(seqs).toHaveLength(2)
expect(seqs[0].name).toBe('Seq 1')
})
it('openSequenceInTimeline opens and activates sequence', async () => {
const { openSequenceInTimeline } = await import('./premiere')
const mockSeq = { name: 'Seq 1', guid: 'guid-1' }
const mockProject = {
openSequence: vi.fn().mockResolvedValue(true),
setActiveSequence: vi.fn().mockResolvedValue(true),
}
const result = await openSequenceInTimeline(
mockSeq as unknown as Sequence,
mockProject as unknown as Project,
)
expect(result).toBe(true)
expect(mockProject.openSequence).toHaveBeenCalledWith(mockSeq)
expect(mockProject.setActiveSequence).toHaveBeenCalledWith(mockSeq)
})
})
})
+178
View File
@@ -0,0 +1,178 @@
import type { Project, Sequence, premierepro } from '@adobe/premierepro'
/**
* Safely resolves the Premiere Pro host module (`premierepro`).
*/
export function getPremiereModule(): premierepro | null {
try {
// In UXP, host modules are available via require()
if (typeof window !== 'undefined' && 'require' in window) {
// Dynamic runtime property injected on window by Adobe UXP
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return (window as any).require('premierepro')
}
if (typeof require !== 'undefined') {
// Adobe UXP host modules must be resolved dynamically at runtime via CommonJS require
// eslint-disable-next-line @typescript-eslint/no-require-imports
return require('premierepro')
}
} catch (err) {
console.warn('[UXP] premierepro module not available:', err)
}
return null
}
/**
* Safely resolves the UXP environment module (`uxp`).
*/
export function getUxpModule(): UxpModule | null {
try {
if (typeof window !== 'undefined' && 'require' in window) {
// Dynamic runtime property injected on window by Adobe UXP
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return (window as any).require('uxp')
}
if (typeof require !== 'undefined') {
// Adobe UXP host modules must be resolved dynamically at runtime via CommonJS require
// eslint-disable-next-line @typescript-eslint/no-require-imports
return require('uxp')
}
} catch (err) {
console.warn('[UXP] uxp module not available:', err)
}
return null
}
/**
* Retrieves the currently active project in Premiere Pro.
*/
export async function getActiveProject(): Promise<Project | null> {
const ppro = getPremiereModule()
if (!ppro?.Project) {
return null
}
try {
return await ppro.Project.getActiveProject()
} catch (err) {
console.error('Failed to get active project:', err)
return null
}
}
/**
* Retrieves the currently active sequence of the project.
*/
export async function getActiveSequence(project?: Project | null): Promise<Sequence | null> {
const pr = project || (await getActiveProject())
if (!pr) return null
try {
const seq = await pr.getActiveSequence()
return seq || null
} catch (err) {
console.error('Failed to get active sequence:', err)
return null
}
}
/**
* Retrieves all sequences in the project.
*/
export async function getAllSequences(project?: Project | null): Promise<Sequence[]> {
const pr = project || (await getActiveProject())
if (!pr) return []
try {
const seqs = await pr.getSequences()
return seqs || []
} catch (err) {
console.error('Failed to get all sequences:', err)
return []
}
}
/**
* Opens and activates a sequence in the Premiere Pro timeline.
*/
export async function openSequenceInTimeline(
sequence: Sequence,
project?: Project | null,
): Promise<boolean> {
const pr = project || (await getActiveProject())
if (!pr) return false
try {
const opened = await pr.openSequence(sequence)
try {
await pr.setActiveSequence(sequence)
} catch {
// setActiveSequence may not be required if openSequence already focuses it
}
return opened ?? true
} catch (err) {
console.error('Failed to open sequence in timeline:', err)
return false
}
}
/**
* Imports one or more files into the Premiere Pro project root.
*/
export async function importFilesIntoProject(
project: Project,
filePaths: string[],
): Promise<boolean> {
if (!filePaths.length) return false
try {
return await project.importFiles(
filePaths,
true, // suppressUI
// @ts-expect-error Premiere Pro UXP requires null instead of undefined to default to project root
null, // targetBin; `null` defaults to project root
false, // asNumberedStills
)
} catch (err) {
console.error('Failed to import files into Premiere project:', err)
return false
}
}
/**
* Opens the native OS folder picker to ask the user where to save files.
* Returns the selected UxpFolderEntry, or null if the user cancelled.
*/
export async function promptSelectFolder(): Promise<UxpFolderEntry | null> {
const uxp = getUxpModule()
if (!uxp?.storage?.localFileSystem) {
throw new Error('UXP storage.localFileSystem is not available.')
}
try {
return await uxp.storage.localFileSystem.getFolder()
} catch (err) {
console.error('Error in promptSelectFolder:', err)
return null
}
}
/**
* Opens the native OS file picker to ask the user where to save a file.
* Returns the selected UxpFileEntry, or null if the user cancelled.
*/
export async function promptSaveFile(defaultName: string): Promise<UxpFileEntry | null> {
const uxp = getUxpModule()
if (!uxp?.storage?.localFileSystem) {
throw new Error('UXP storage.localFileSystem is not available.')
}
try {
return await uxp.storage.localFileSystem.getFileForSaving(defaultName)
} catch (err) {
console.error('Error in promptSaveFile:', err)
return null
}
}
/**
* Writes an ArrayBuffer into a UXP File entry as binary.
*/
export async function writeBinaryFile(file: UxpFileEntry, data: ArrayBuffer): Promise<void> {
const uxp = getUxpModule()
const format = uxp?.storage?.formats?.binary
await file.write(data, { format })
}
@@ -0,0 +1,55 @@
import { describe, it, expect, beforeEach } from 'vitest'
import { getStoredCredentials, saveStoredCredentials, clearStoredCredentials } from './storage'
const localStorageMock = (() => {
let store: Record<string, string> = {}
return {
getItem: (key: string) => store[key] || null,
setItem: (key: string, value: string) => {
store[key] = value.toString()
},
removeItem: (key: string) => {
delete store[key]
},
clear: () => {
store = {}
},
}
})()
Object.defineProperty(globalThis, 'localStorage', {
value: localStorageMock,
configurable: true,
writable: true,
})
describe('Storage Service', () => {
beforeEach(() => {
localStorage.clear()
})
it('returns null when no credentials are stored', () => {
expect(getStoredCredentials()).toBeNull()
})
it('saves and retrieves credentials correctly', () => {
saveStoredCredentials('http://localhost:3000', 'test-api-key')
const creds = getStoredCredentials()
expect(creds).toEqual({
endpoint: 'http://localhost:3000',
apiKey: 'test-api-key',
})
})
it('normalizes endpoint URL by stripping trailing slashes', () => {
saveStoredCredentials('https://api.shumai.io///', 'test-api-key')
const creds = getStoredCredentials()
expect(creds?.endpoint).toBe('https://api.shumai.io')
})
it('clears stored credentials', () => {
saveStoredCredentials('http://localhost:3000', 'test-api-key')
clearStoredCredentials()
expect(getStoredCredentials()).toBeNull()
})
})
+38
View File
@@ -0,0 +1,38 @@
export interface StoredCredentials {
endpoint: string
apiKey: string
}
const STORAGE_KEY_ENDPOINT = 'shumai_uxp_endpoint'
const STORAGE_KEY_API_KEY = 'shumai_uxp_api_key'
export function getStoredCredentials(): StoredCredentials | null {
try {
const endpoint = localStorage.getItem(STORAGE_KEY_ENDPOINT)
const apiKey = localStorage.getItem(STORAGE_KEY_API_KEY)
if (endpoint && apiKey) {
return { endpoint, apiKey }
}
} catch (err) {
console.error('Failed to read credentials from localStorage:', err)
}
return null
}
export function saveStoredCredentials(endpoint: string, apiKey: string): void {
try {
localStorage.setItem(STORAGE_KEY_ENDPOINT, endpoint.trim().replace(/\/+$/, ''))
localStorage.setItem(STORAGE_KEY_API_KEY, apiKey.trim())
} catch (err) {
console.error('Failed to save credentials to localStorage:', err)
}
}
export function clearStoredCredentials(): void {
try {
localStorage.removeItem(STORAGE_KEY_ENDPOINT)
localStorage.removeItem(STORAGE_KEY_API_KEY)
} catch (err) {
console.error('Failed to clear credentials from localStorage:', err)
}
}
+13
View File
@@ -0,0 +1,13 @@
export interface LinkedSequenceAsset {
sequenceGuid: string
sequenceName: string
assetId: string
assetName: string
assetThumbnailUrl?: string
endpoint?: string
projectId?: string
syncedCommentIds: string[]
syncedMarkerGuids?: string[]
lastSyncAt: number
totalCommentsSynced: number
}
+27
View File
@@ -0,0 +1,27 @@
export function formatDateAgo(dateInput?: string | number | Date | null): string {
if (!dateInput) return ''
const date =
typeof dateInput === 'string' || typeof dateInput === 'number' ? new Date(dateInput) : dateInput
if (isNaN(date.getTime())) return ''
const now = new Date()
const diffSec = Math.max(0, Math.floor((now.getTime() - date.getTime()) / 1000))
if (diffSec < 60) return 'just now'
const diffMin = Math.floor(diffSec / 60)
if (diffMin < 60) return `${diffMin}m ago`
const diffHours = Math.floor(diffMin / 60)
if (diffHours < 24) return `${diffHours}h ago`
const diffDays = Math.floor(diffHours / 24)
if (diffDays === 1) return 'yesterday'
if (diffDays < 30) return `${diffDays}d ago`
const diffMonths = Math.floor(diffDays / 30)
if (diffMonths < 12) return `${diffMonths}mo ago`
const diffYears = Math.floor(diffMonths / 12)
return `${diffYears}y ago`
}
@@ -0,0 +1,44 @@
import { describe, it, expect } from 'vitest'
import { formatBytes, formatDuration } from './format'
describe('formatBytes', () => {
it('handles null, undefined, 0 and invalid inputs', () => {
expect(formatBytes(null)).toBe('0 B')
expect(formatBytes(undefined)).toBe('0 B')
expect(formatBytes(0)).toBe('0 B')
expect(formatBytes(-100)).toBe('0 B')
expect(formatBytes(NaN)).toBe('0 B')
})
it('formats bytes correctly', () => {
expect(formatBytes(500)).toBe('500 B')
expect(formatBytes(1024)).toBe('1.0 KB')
expect(formatBytes(1536)).toBe('1.5 KB')
expect(formatBytes(1048576)).toBe('1.0 MB')
expect(formatBytes(1073741824)).toBe('1.0 GB')
})
})
describe('formatDuration', () => {
it('returns null for invalid or non-positive durations', () => {
expect(formatDuration(null)).toBeNull()
expect(formatDuration(undefined)).toBeNull()
expect(formatDuration(0)).toBeNull()
expect(formatDuration(-15)).toBeNull()
expect(formatDuration(NaN)).toBeNull()
})
it('formats seconds into MM:SS format', () => {
expect(formatDuration(5.4)).toBe('00:05')
expect(formatDuration(59)).toBe('00:59')
expect(formatDuration(60)).toBe('01:00')
expect(formatDuration(65)).toBe('01:05')
expect(formatDuration(3599)).toBe('59:59')
})
it('formats hours into H:MM:SS format', () => {
expect(formatDuration(3600)).toBe('1:00:00')
expect(formatDuration(3665)).toBe('1:01:05')
expect(formatDuration(36665)).toBe('10:11:05')
})
})
+26
View File
@@ -0,0 +1,26 @@
/**
* Formats a byte count into a human-readable size string (e.g. 1.2 MB, 450 KB).
*/
export function formatBytes(bytes?: number | null): string {
if (bytes == null || bytes === 0 || isNaN(bytes) || bytes < 0) return '0 B'
const units = ['B', 'KB', 'MB', 'GB', 'TB']
const i = Math.floor(Math.log(bytes) / Math.log(1024))
const safeIndex = Math.min(Math.max(0, i), units.length - 1)
return `${(bytes / Math.pow(1024, safeIndex)).toFixed(safeIndex === 0 ? 0 : 1)} ${units[safeIndex]}`
}
/**
* Formats duration in seconds into MM:SS or H:MM:SS format (e.g. 02:45, 1:12:30).
* Returns null if duration is invalid, zero or negative.
*/
export function formatDuration(seconds?: number | null): string | null {
if (seconds == null || isNaN(seconds) || seconds <= 0) return null
const totalSecs = Math.round(seconds)
const hours = Math.floor(totalSecs / 3600)
const minutes = Math.floor((totalSecs % 3600) / 60)
const secs = totalSecs % 60
if (hours > 0) {
return `${hours}:${minutes.toString().padStart(2, '0')}:${secs.toString().padStart(2, '0')}`
}
return `${minutes.toString().padStart(2, '0')}:${secs.toString().padStart(2, '0')}`
}
+72
View File
@@ -0,0 +1,72 @@
import { describe, it, expect } from 'vitest'
import { resolveAssetUrl, normalizeEndpoint, isSameEndpoint } from './url'
describe('resolveAssetUrl', () => {
it('returns undefined for empty or null inputs', () => {
expect(resolveAssetUrl(null, 'http://localhost:3000')).toBeUndefined()
expect(resolveAssetUrl(undefined, 'http://localhost:3000')).toBeUndefined()
expect(resolveAssetUrl('', 'http://localhost:3000')).toBeUndefined()
})
it('returns original url if endpoint is not provided', () => {
expect(resolveAssetUrl('/files/123')).toBe('/files/123')
expect(resolveAssetUrl('http://example.com/img.png')).toBe('http://example.com/img.png')
})
it('prepends endpoint to relative paths', () => {
expect(resolveAssetUrl('/files/shumai/cat.png', 'http://localhost:3000')).toBe(
'http://localhost:3000/files/shumai/cat.png',
)
expect(resolveAssetUrl('/files/shumai/cat.png', 'http://localhost:3000/')).toBe(
'http://localhost:3000/files/shumai/cat.png',
)
})
it('preserves absolute URLs intact even when hosts differ', () => {
const localRaw = 'http://localhost:3000/files/shumai/files/cat.webp'
const endpoint = 'http://127.0.0.1:3000'
expect(resolveAssetUrl(localRaw, endpoint)).toBe(localRaw)
const remoteEndpoint = 'https://shumai.example.com'
expect(resolveAssetUrl(localRaw, remoteEndpoint)).toBe(localRaw)
})
it('keeps matching absolute URLs intact', () => {
const raw = 'http://localhost:3000/files/shumai/cat.png'
expect(resolveAssetUrl(raw, 'http://localhost:3000')).toBe(raw)
})
it('preserves remote cloud storage presigned URLs without rewriting host', () => {
const r2Url =
'https://04e37a3c563610bccea6a3ce6f8618ca.r2.cloudflarestorage.com/shumai/files/01KYKNT8NEJ3Q1G6A6K08M2XHC/Float%2002-480p.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Signature=8112ab30'
const endpoint = 'https://staging.shumai.one'
expect(resolveAssetUrl(r2Url, endpoint)).toBe(r2Url)
})
})
describe('normalizeEndpoint', () => {
it('handles empty and null values', () => {
expect(normalizeEndpoint('')).toBe('')
expect(normalizeEndpoint(null)).toBe('')
expect(normalizeEndpoint(undefined)).toBe('')
})
it('trims whitespace and trailing slashes and converts to lower case', () => {
expect(normalizeEndpoint(' https://STAGING.shumai.one/// ')).toBe('https://staging.shumai.one')
expect(normalizeEndpoint('http://localhost:3000/')).toBe('http://localhost:3000')
})
})
describe('isSameEndpoint', () => {
it('returns true when endpoints match ignoring slashes and casing', () => {
expect(isSameEndpoint('https://staging.shumai.one/', 'https://STAGING.shumai.one')).toBe(true)
expect(isSameEndpoint('http://localhost:3000', 'http://localhost:3000/')).toBe(true)
})
it('returns false when endpoints differ', () => {
expect(isSameEndpoint('http://localhost:3000', 'https://staging.shumai.one')).toBe(false)
expect(isSameEndpoint('http://localhost:3000', 'http://127.0.0.1:3000')).toBe(false)
expect(isSameEndpoint('', 'http://localhost:3000')).toBe(false)
expect(isSameEndpoint(null, undefined)).toBe(false)
})
})
+43
View File
@@ -0,0 +1,43 @@
/**
* Utility functions for URL manipulation and resolution in UXP plugins.
*/
/**
* Resolves an asset URL (such as a thumbnail or file download) against
* the user-configured Shumai endpoint.
*
* Handles:
* - Relative paths (/files/..., /api/...) by prepending the endpoint.
* - Absolute URLs (http://, https://) are preserved as-is.
*/
export function resolveAssetUrl(url?: string | null, endpoint?: string): string | undefined {
if (!url) return undefined
if (!endpoint) return url
const cleanEndpoint = endpoint.replace(/\/+$/, '')
// Handle relative URLs (e.g. /files/..., /api/...)
if (url.startsWith('/') && !url.startsWith('//')) {
return `${cleanEndpoint}${url}`
}
return url
}
/**
* Normalizes an endpoint URL by trimming whitespace, stripping trailing slashes,
* and converting to lower case for reliable comparison.
*/
export function normalizeEndpoint(endpoint?: string | null): string {
if (!endpoint) return ''
return endpoint.trim().replace(/\/+$/, '').toLowerCase()
}
/**
* Checks if two endpoints refer to the same server URL.
*/
export function isSameEndpoint(ep1?: string | null, ep2?: string | null): boolean {
const n1 = normalizeEndpoint(ep1)
const n2 = normalizeEndpoint(ep2)
return Boolean(n1 && n2 && n1 === n2)
}
+169
View File
@@ -0,0 +1,169 @@
import React, { useState } from 'react'
import { getShumaiClient } from '../api/client'
import { saveStoredCredentials } from '../services/storage'
import { Button } from '@swc-react/button'
import { Textfield } from '@swc-react/textfield'
import { FieldLabel } from '@swc-react/field-label'
import { HelpText } from '@swc-react/help-text'
import { ProgressCircle } from '@swc-react/progress-circle'
interface AuthViewProps {
initialEndpoint?: string
initialApiKey?: string
onConnectSuccess: (endpoint: string, apiKey: string) => void
}
export const AuthView: React.FC<AuthViewProps> = ({
initialEndpoint = 'http://localhost:3000',
initialApiKey = '',
onConnectSuccess,
}) => {
const [endpoint, setEndpoint] = useState(initialEndpoint)
const [apiKey, setApiKey] = useState(initialApiKey)
const [loading, setLoading] = useState(false)
const [errorMessage, setErrorMessage] = useState<string | null>(null)
const handleConnect = async (e?: React.SyntheticEvent) => {
if (e) {
e.preventDefault()
}
setErrorMessage(null)
const trimmedEndpoint = endpoint.trim().replace(/\/+$/, '')
const trimmedKey = apiKey.trim()
if (!trimmedEndpoint) {
setErrorMessage('Please enter your Shumai server endpoint.')
return
}
if (!trimmedKey) {
setErrorMessage('Please enter your Shumai API key.')
return
}
try {
new URL(trimmedEndpoint)
} catch {
setErrorMessage(
'Invalid endpoint URL. Example: http://localhost:3000 or https://shumai.example.com',
)
return
}
setLoading(true)
console.log('[Shumai UXP] Connecting to:', trimmedEndpoint)
try {
const client = getShumaiClient(trimmedEndpoint, trimmedKey)
const res = await client.api.projects.$get({
query: { first: '1' },
})
console.log('[Shumai UXP] Response status:', res.status)
if (res.status === 401) {
setErrorMessage('Unauthorized: Invalid API Key. Please verify your token.')
setLoading(false)
return
}
if (!res.ok) {
const errorData = (await res.json().catch(() => ({}))) as { error?: string }
setErrorMessage(errorData.error || `Connection failed with status ${res.status}`)
setLoading(false)
return
}
// Validated successfully
saveStoredCredentials(trimmedEndpoint, trimmedKey)
onConnectSuccess(trimmedEndpoint, trimmedKey)
} catch (err) {
console.error('[Shumai UXP] Failed to connect to Shumai server:', err)
setErrorMessage(
err instanceof Error
? `Cannot reach server: ${err.message}`
: 'Could not connect to the Shumai server. Please check the URL and your network connection.',
)
} finally {
setLoading(false)
}
}
const handleKeyDown = (e: React.KeyboardEvent) => {
if (e.key === 'Enter') {
e.preventDefault()
handleConnect(e)
}
}
return (
<div className="view-content" style={{ justifyContent: 'center' }}>
<div className="auth-container">
<div className="auth-header">
<h2>Connect to Shumai</h2>
<p>Enter your server URL and API key to integrate Premiere Pro with your workspace.</p>
</div>
{errorMessage && (
<div style={{ marginBottom: '12px' }}>
<HelpText variant="negative" icon>
{errorMessage}
</HelpText>
</div>
)}
<div className="auth-form">
<div className="form-group">
<FieldLabel for="endpoint-input">Server Endpoint</FieldLabel>
<Textfield
id="endpoint-input"
style={{ width: '100%' }}
placeholder="https://shumai.example.com"
value={endpoint}
onInput={(e: React.FormEvent<HTMLElement>) =>
setEndpoint((e.target as HTMLInputElement).value)
}
onKeyDown={handleKeyDown}
disabled={loading}
invalid={Boolean(errorMessage && !endpoint.trim())}
/>
<HelpText>The base URL of your Shumai backend instance.</HelpText>
</div>
<div className="form-group">
<FieldLabel for="api-key-input">API Key</FieldLabel>
<Textfield
id="api-key-input"
type="password"
style={{ width: '100%' }}
placeholder="Paste your API key here"
value={apiKey}
onInput={(e: React.FormEvent<HTMLElement>) =>
setApiKey((e.target as HTMLInputElement).value)
}
onKeyDown={handleKeyDown}
disabled={loading}
invalid={Boolean(errorMessage && !apiKey.trim())}
/>
<HelpText>Generate an API key in Shumai: Settings &gt; Developer.</HelpText>
</div>
<Button
variant="accent"
onClick={handleConnect}
style={{ width: '100%', marginTop: '8px' }}
disabled={loading}
>
{loading ? 'Connecting...' : 'Connect Workspace'}
{loading ? (
<ProgressCircle indeterminate size="s" static-color="white" slot="icon" />
) : (
<sp-icon-arrow-right size="s" slot="icon"></sp-icon-arrow-right>
)}
</Button>
</div>
</div>
</div>
)
}
@@ -0,0 +1,790 @@
import React, { useEffect, useState, useCallback } from 'react'
import { getShumaiClient } from '../api/client'
import { Breadcrumb, BreadcrumbCrumb } from '../components/Breadcrumb'
import { FileCardItem, AssetSummary } from '../components/FileItem'
import { ImportVideoDialog } from '../components/ImportVideoDialog'
import { LinkSequenceDialog } from '../components/LinkSequenceDialog'
import {
getAllSequenceLinksFromCache,
getAllLinkedSequences,
normalizeGuid,
removeSequenceLink,
removeSequenceLinkFromCache,
} from '../services/linkStorage'
import { getActiveProject, getAllSequences } from '../services/premiere'
import type { LinkedSequenceAsset } from '../types/link'
import { importAssetIntoPremiere, type ProxyOption } from '../services/import'
import { ProjectSummary } from './ProjectsView'
import { isSameEndpoint } from '../utils/url'
import { ActionButton } from '@swc-react/action-button'
import { Button } from '@swc-react/button'
import { Search } from '@swc-react/search'
import { ProgressCircle } from '@swc-react/progress-circle'
import { StatusLight } from '@swc-react/status-light'
import { IllustratedMessage } from '@swc-react/illustrated-message'
import { Divider } from '@swc-react/divider'
import type { SearchCondition, SearchSort } from '@shumai/dtos'
const PAGE_SIZE = 20
interface FileListViewProps {
endpoint: string
apiKey: string
project: ProjectSummary
onBackToProjects: () => void
onLinkCountChange?: (count: number) => void
}
export const FileListView: React.FC<FileListViewProps> = ({
endpoint,
apiKey,
project,
onBackToProjects,
onLinkCountChange,
}) => {
const [currentFolderId, setCurrentFolderId] = useState<string | null>(project.rootFolder || null)
const [crumbs, setCrumbs] = useState<BreadcrumbCrumb[]>([])
// Folders state
const [folders, setFolders] = useState<AssetSummary[]>([])
const [foldersTotal, setFoldersTotal] = useState<number | null>(null)
const [foldersCursor, setFoldersCursor] = useState<string | null>(null)
const [foldersHasNext, setFoldersHasNext] = useState(false)
const [foldersExpanded, setFoldersExpanded] = useState(true)
const [loadingMoreFolders, setLoadingMoreFolders] = useState(false)
// Files state
const [files, setFiles] = useState<AssetSummary[]>([])
const [filesTotal, setFilesTotal] = useState<number | null>(null)
const [filesCursor, setFilesCursor] = useState<string | null>(null)
const [filesHasNext, setFilesHasNext] = useState(false)
const [filesExpanded, setFilesExpanded] = useState(true)
const [loadingMoreFiles, setLoadingMoreFiles] = useState(false)
const [loading, setLoading] = useState(true)
const [error, setError] = useState<string | null>(null)
const [searchTerm, setSearchTerm] = useState('')
const [debouncedSearch, setDebouncedSearch] = useState('')
const [videoForDialog, setVideoForDialog] = useState<AssetSummary | null>(null)
const [assetForLinkDialog, setAssetForLinkDialog] = useState<AssetSummary | null>(null)
const [linkedAssetsMap, setLinkedAssetsMap] = useState<Record<string, LinkedSequenceAsset>>({})
// Refresh links from cache and active Premiere project
const refreshLinkedAssets = useCallback(async () => {
// 1. Immediately read from cache (fast, non-blocking)
const cachedLinks = getAllSequenceLinksFromCache()
if (cachedLinks.length > 0) {
const map: Record<string, LinkedSequenceAsset> = {}
for (const link of cachedLinks) {
if (!link.endpoint || isSameEndpoint(link.endpoint, endpoint)) {
map[link.assetId] = link
}
}
setLinkedAssetsMap((prev) => ({ ...prev, ...map }))
onLinkCountChange?.(Object.keys(map).length)
}
// 2. Query active project in Premiere Pro for live persistent links
try {
const pr = await getActiveProject()
if (pr) {
const liveLinks = await getAllLinkedSequences(pr)
const liveMap: Record<string, LinkedSequenceAsset> = {}
for (const link of liveLinks) {
if (!link.endpoint || isSameEndpoint(link.endpoint, endpoint)) {
liveMap[link.assetId] = link
}
}
setLinkedAssetsMap(liveMap)
onLinkCountChange?.(Object.keys(liveMap).length)
}
} catch (err) {
console.warn('[FileListView] Could not get linked sequences from active project:', err)
}
}, [endpoint, onLinkCountChange])
useEffect(() => {
void refreshLinkedAssets()
}, [refreshLinkedAssets])
const handleUnlinkAsset = useCallback(
async (asset: AssetSummary) => {
const link = linkedAssetsMap[asset.id]
if (!link) return
// Optimistically remove from state immediately
setLinkedAssetsMap((prev) => {
const copy = { ...prev }
delete copy[asset.id]
return copy
})
try {
const pr = await getActiveProject()
if (pr) {
const allSeqs = await getAllSequences(pr)
const targetSeq = allSeqs.find(
(s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid),
)
if (targetSeq) {
await removeSequenceLink(pr, targetSeq)
} else {
removeSequenceLinkFromCache(link.sequenceGuid, pr.guid ? pr.guid.toString() : null)
}
} else {
removeSequenceLinkFromCache(link.sequenceGuid)
}
void refreshLinkedAssets()
setImportStatus({
id: Date.now().toString(),
fileName: asset.name,
status: 'success',
message: `Unlinked from "${link.sequenceName}".`,
})
setTimeout(() => {
setImportStatus((prev) => (prev?.fileName === asset.name ? null : prev))
}, 3000)
} catch (err) {
console.error('Failed to unlink asset:', err)
void refreshLinkedAssets()
setImportStatus({
id: Date.now().toString(),
fileName: asset.name,
status: 'error',
message: 'Failed to unlink sequence.',
})
setTimeout(() => {
setImportStatus((prev) => (prev?.fileName === asset.name ? null : prev))
}, 4000)
}
},
[linkedAssetsMap, refreshLinkedAssets],
)
// Import task state
const [importStatus, setImportStatus] = useState<{
id: string
fileName: string
status: 'importing' | 'success' | 'error'
message: string
} | null>(null)
const runImport = async (asset: AssetSummary, type: 'raw' | 'proxy', proxyItem?: ProxyOption) => {
const taskId = Date.now().toString()
const label = type === 'raw' ? asset.name : `${asset.name} (${proxyItem?.label || 'Proxy'})`
setImportStatus({
id: taskId,
fileName: label,
status: 'importing',
message: 'Starting import...',
})
try {
const result = await importAssetIntoPremiere({
endpoint,
apiKey,
asset,
type,
proxyItem,
onProgress: (msg) => {
setImportStatus((prev) => (prev?.id === taskId ? { ...prev, message: msg } : prev))
},
})
if (result.cancelled) {
setImportStatus(null)
return
}
if (result.success) {
setImportStatus({
id: taskId,
fileName: result.fileName || label,
status: 'success',
message: result.message,
})
setTimeout(() => {
setImportStatus((prev) => (prev?.id === taskId ? null : prev))
}, 4000)
} else {
setImportStatus({
id: taskId,
fileName: label,
status: 'error',
message: result.message,
})
setTimeout(() => {
setImportStatus((prev) => (prev?.id === taskId ? null : prev))
}, 6000)
}
} catch (err) {
setImportStatus({
id: taskId,
fileName: label,
status: 'error',
message: err instanceof Error ? err.message : 'Import failed.',
})
setTimeout(() => {
setImportStatus((prev) => (prev?.id === taskId ? null : prev))
}, 6000)
}
}
const handleImportRaw = (asset: AssetSummary) => {
runImport(asset, 'raw')
}
const handleImportProxy = (asset: AssetSummary, proxy: ProxyOption) => {
runImport(asset, 'proxy', proxy)
}
// Debounce search term by 300ms
useEffect(() => {
const timer = setTimeout(() => {
setDebouncedSearch(searchTerm.trim())
}, 300)
return () => clearTimeout(timer)
}, [searchTerm])
// Initial fetch of both folders and files
const fetchContents = useCallback(
async (folderId: string, query: string) => {
setLoading(true)
setError(null)
try {
const client = getShumaiClient(endpoint, apiKey)
const isSearching = Boolean(query)
const conditions: SearchCondition[] = isSearching
? [{ field: 'name', operator: 'contains', value: query }]
: []
const sort: SearchSort = { field: 'name', order: 'asc' }
// Fetch first page of folders and files in parallel
const [foldersRes, filesRes] = await Promise.all([
client.api.folders[':folderId'].search.$post({
param: { folderId },
json: {
assetType: 'folder',
recursively: isSearching,
conditions,
sort,
first: PAGE_SIZE,
previewFormat: 'jpeg',
},
}),
client.api.folders[':folderId'].search.$post({
param: { folderId },
json: {
assetType: 'file',
recursively: isSearching,
conditions,
sort,
first: PAGE_SIZE,
previewFormat: 'jpeg',
},
}),
])
if (!foldersRes.ok) {
const errData = (await foldersRes.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to search folders (${foldersRes.status})`)
}
if (!filesRes.ok) {
const errData = (await filesRes.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to search files (${filesRes.status})`)
}
const foldersBody = await foldersRes.json()
const filesBody = await filesRes.json()
const folderItems = (foldersBody.data || []) as AssetSummary[]
const fileItems = (filesBody.data || []) as AssetSummary[]
setFolders(folderItems)
setFoldersCursor(foldersBody.pageInfo?.cursor || null)
setFoldersHasNext(Boolean(foldersBody.pageInfo?.cursor))
setFoldersTotal(foldersBody.pageInfo?.total ?? folderItems.length)
setFiles(fileItems)
setFilesCursor(filesBody.pageInfo?.cursor || null)
setFilesHasNext(Boolean(filesBody.pageInfo?.cursor))
setFilesTotal(filesBody.pageInfo?.total ?? fileItems.length)
} catch (err) {
console.error('Error fetching folder contents via search API:', err)
setError(err instanceof Error ? err.message : 'Failed to load folder contents.')
} finally {
setLoading(false)
}
},
[endpoint, apiKey],
)
useEffect(() => {
if (currentFolderId) {
fetchContents(currentFolderId, debouncedSearch)
} else {
setError('Root folder ID not available for this project.')
setLoading(false)
}
}, [currentFolderId, debouncedSearch, fetchContents])
// Paginate next files
const fetchNextFilesPage = useCallback(async () => {
if (!currentFolderId || !filesHasNext || loadingMoreFiles || loading) return
setLoadingMoreFiles(true)
try {
const client = getShumaiClient(endpoint, apiKey)
const isSearching = Boolean(debouncedSearch)
const conditions: SearchCondition[] = isSearching
? [{ field: 'name', operator: 'contains', value: debouncedSearch }]
: []
const sort: SearchSort = { field: 'name', order: 'asc' }
const res = await client.api.folders[':folderId'].search.$post({
param: { folderId: currentFolderId },
json: {
assetType: 'file',
recursively: isSearching,
conditions,
sort,
first: PAGE_SIZE,
after: filesCursor || undefined,
previewFormat: 'jpeg',
},
})
if (res.ok) {
const body = await res.json()
const newFiles = (body.data || []) as AssetSummary[]
setFiles((prev) => [...prev, ...newFiles])
setFilesCursor(body.pageInfo?.cursor || null)
setFilesHasNext(Boolean(body.pageInfo?.cursor))
if (body.pageInfo?.total != null) {
setFilesTotal(body.pageInfo.total)
}
}
} catch (err) {
console.error('Error fetching next files page:', err)
} finally {
setLoadingMoreFiles(false)
}
}, [
currentFolderId,
filesHasNext,
loadingMoreFiles,
loading,
endpoint,
apiKey,
debouncedSearch,
filesCursor,
])
// Paginate next folders
const fetchNextFoldersPage = useCallback(async () => {
if (!currentFolderId || !foldersHasNext || loadingMoreFolders || loading) return
setLoadingMoreFolders(true)
try {
const client = getShumaiClient(endpoint, apiKey)
const isSearching = Boolean(debouncedSearch)
const conditions: SearchCondition[] = isSearching
? [{ field: 'name', operator: 'contains', value: debouncedSearch }]
: []
const sort: SearchSort = { field: 'name', order: 'asc' }
const res = await client.api.folders[':folderId'].search.$post({
param: { folderId: currentFolderId },
json: {
assetType: 'folder',
recursively: isSearching,
conditions,
sort,
first: PAGE_SIZE,
after: foldersCursor || undefined,
previewFormat: 'jpeg',
},
})
if (res.ok) {
const body = await res.json()
const newFolders = (body.data || []) as AssetSummary[]
setFolders((prev) => [...prev, ...newFolders])
setFoldersCursor(body.pageInfo?.cursor || null)
setFoldersHasNext(Boolean(body.pageInfo?.cursor))
if (body.pageInfo?.total != null) {
setFoldersTotal(body.pageInfo.total)
}
}
} catch (err) {
console.error('Error fetching next folders page:', err)
} finally {
setLoadingMoreFolders(false)
}
}, [
currentFolderId,
foldersHasNext,
loadingMoreFolders,
loading,
endpoint,
apiKey,
debouncedSearch,
foldersCursor,
])
// Infinite scroll listener
const handleScroll = (e: React.UIEvent<HTMLDivElement>) => {
const target = e.currentTarget
const threshold = 120
const isNearBottom = target.scrollHeight - target.scrollTop - target.clientHeight <= threshold
if (isNearBottom) {
if (filesExpanded && filesHasNext && !loadingMoreFiles) {
fetchNextFilesPage()
} else if (
foldersExpanded &&
foldersHasNext &&
!loadingMoreFolders &&
(!filesExpanded || files.length === 0)
) {
fetchNextFoldersPage()
}
}
}
const handleFolderClick = (folder: AssetSummary) => {
setCrumbs((prev) => [...prev, { id: folder.id, name: folder.name }])
setCurrentFolderId(folder.id)
setSearchTerm('')
}
const handleCrumbNavigate = (crumbIndex: number) => {
setSearchTerm('')
if (crumbIndex === -1) {
setCrumbs([])
if (project.rootFolder) {
setCurrentFolderId(project.rootFolder)
}
} else {
const targetCrumb = crumbs[crumbIndex]
setCrumbs((prev) => prev.slice(0, crumbIndex + 1))
setCurrentFolderId(targetCrumb.id)
}
}
return (
<div
style={{
display: 'flex',
flexDirection: 'column',
flex: 1,
minHeight: 0,
overflow: 'hidden',
}}
>
<Breadcrumb
projectName={project.name}
crumbs={crumbs}
onNavigateToProjects={onBackToProjects}
onNavigateToCrumb={handleCrumbNavigate}
/>
{/* Sticky Header: Search input & Refresh button */}
<div className="view-sticky-header">
<div
style={{
display: 'flex',
alignItems: 'center',
gap: '8px',
marginBottom: '8px',
}}
>
<div style={{ flex: 1 }}>
<Search
style={{ width: '100%' }}
placeholder="Search files and folders..."
value={searchTerm}
onInput={(e: React.FormEvent<HTMLElement>) =>
setSearchTerm((e.target as HTMLInputElement).value)
}
/>
</div>
<sp-button
quiet
variant="secondary"
size="s"
label="Refresh folder"
icon-only
onClick={() => {
if (currentFolderId) {
fetchContents(currentFolderId, debouncedSearch)
void refreshLinkedAssets()
}
}}
title="Refresh folder"
disabled={loading || !currentFolderId}
>
<sp-icon-refresh
slot="icon"
size="s"
className={loading ? 'spin' : ''}
></sp-icon-refresh>
</sp-button>
</div>
<Divider size="s" />
</div>
<div className="view-content" onScroll={handleScroll}>
{loading && (
<div className="state-container">
<ProgressCircle indeterminate size="m" label="Loading folder contents..." />
<p style={{ marginTop: '8px' }}>Loading folder contents...</p>
</div>
)}
{error && !loading && (
<div className="state-container">
<IllustratedMessage heading="Error loading folder" description={error}>
<sp-icon-alert-circle
size="xxl"
style={{ color: 'var(--accent-red)' }}
></sp-icon-alert-circle>
</IllustratedMessage>
{currentFolderId && (
<Button
variant="secondary"
onClick={() => fetchContents(currentFolderId, debouncedSearch)}
style={{ marginTop: '12px' }}
>
Try Again
</Button>
)}
</div>
)}
{!loading && !error && folders.length === 0 && files.length === 0 && (
<div className="state-container">
<IllustratedMessage
heading={searchTerm ? 'No matching items' : 'Folder is empty'}
description={
searchTerm
? `No files or subfolders match "${searchTerm}".`
: 'No files or subfolders found in this directory.'
}
>
<sp-icon-folder-open size="xxl" style={{ color: '#999999' }}></sp-icon-folder-open>
</IllustratedMessage>
</div>
)}
{!loading && !error && (folders.length > 0 || files.length > 0) && (
<>
{/* Folders Section */}
{folders.length > 0 && (
<div className="section-container">
<div
className="section-header"
onClick={() => setFoldersExpanded(!foldersExpanded)}
role="button"
tabIndex={0}
title={foldersExpanded ? 'Collapse Folders' : 'Expand Folders'}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
setFoldersExpanded(!foldersExpanded)
}
}}
>
<div className="section-header-left">
<sp-button
quiet
variant="secondary"
size="xs"
label={foldersExpanded ? 'Collapse Folders' : 'Expand Folders'}
icon-only
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
setFoldersExpanded(!foldersExpanded)
}}
>
{foldersExpanded ? (
<sp-icon-chevron-down slot="icon" size="xs"></sp-icon-chevron-down>
) : (
<sp-icon-chevron-right slot="icon" size="xs"></sp-icon-chevron-right>
)}
</sp-button>
<span className="section-title">Folders</span>
<span className="count-badge">{foldersTotal ?? folders.length}</span>
</div>
</div>
{foldersExpanded && (
<>
<div className="file-card-list">
{folders.map((folder) => (
<FileCardItem
key={folder.id}
asset={folder}
endpoint={endpoint}
onClick={() => handleFolderClick(folder)}
/>
))}
</div>
{foldersHasNext && (
<div style={{ display: 'flex', justifyContent: 'center', padding: '6px 0' }}>
{loadingMoreFolders ? (
<ProgressCircle indeterminate size="s" label="Loading more folders..." />
) : (
<ActionButton quiet size="s" onClick={fetchNextFoldersPage}>
Load more folders
</ActionButton>
)}
</div>
)}
</>
)}
</div>
)}
{/* Files Section */}
{files.length > 0 && (
<div
className="section-container"
style={{ marginTop: folders.length > 0 && foldersExpanded ? '14px' : '4px' }}
>
<div
className="section-header"
onClick={() => setFilesExpanded(!filesExpanded)}
role="button"
tabIndex={0}
title={filesExpanded ? 'Collapse Files' : 'Expand Files'}
onKeyDown={(e) => {
if (e.key === 'Enter' || e.key === ' ') {
e.preventDefault()
setFilesExpanded(!filesExpanded)
}
}}
>
<div className="section-header-left">
<sp-button
quiet
variant="secondary"
size="xs"
label={filesExpanded ? 'Collapse Files' : 'Expand Files'}
icon-only
onClick={(e: React.MouseEvent) => {
e.stopPropagation()
setFilesExpanded(!filesExpanded)
}}
>
{filesExpanded ? (
<sp-icon-chevron-down slot="icon" size="xs"></sp-icon-chevron-down>
) : (
<sp-icon-chevron-right slot="icon" size="xs"></sp-icon-chevron-right>
)}
</sp-button>
<span className="section-title">Files</span>
<span className="count-badge">{filesTotal ?? files.length}</span>
</div>
</div>
{filesExpanded && (
<>
<div className="file-card-list">
{files.map((file) => (
<FileCardItem
key={file.id}
asset={file}
endpoint={endpoint}
apiKey={apiKey}
onClick={() => {}}
onImportRaw={handleImportRaw}
onSelectVideoForImport={setVideoForDialog}
onLinkSequence={setAssetForLinkDialog}
onUnlinkSequence={handleUnlinkAsset}
isLinked={Boolean(linkedAssetsMap[file.id])}
linkedSequenceName={linkedAssetsMap[file.id]?.sequenceName}
/>
))}
</div>
{loadingMoreFiles && (
<div style={{ display: 'flex', justifyContent: 'center', padding: '10px 0' }}>
<ProgressCircle indeterminate size="s" label="Loading more files..." />
</div>
)}
{filesHasNext && !loadingMoreFiles && (
<div style={{ display: 'flex', justifyContent: 'center', padding: '6px 0' }}>
<ActionButton quiet size="s" onClick={fetchNextFilesPage}>
Load more files
</ActionButton>
</div>
)}
</>
)}
</div>
)}
</>
)}
</div>
{/* Video Import Modal Dialog */}
<ImportVideoDialog
asset={videoForDialog}
endpoint={endpoint}
apiKey={apiKey}
isOpen={videoForDialog != null}
onClose={() => setVideoForDialog(null)}
onImportRaw={handleImportRaw}
onImportProxy={handleImportProxy}
/>
{/* Sequence Linking Modal Dialog */}
<LinkSequenceDialog
asset={assetForLinkDialog}
endpoint={endpoint}
apiKey={apiKey}
isOpen={assetForLinkDialog != null}
onClose={() => setAssetForLinkDialog(null)}
onLinkSuccess={(newLink, addedCount) => {
setLinkedAssetsMap((prev) => ({
...prev,
[newLink.assetId]: newLink,
}))
void refreshLinkedAssets()
setImportStatus({
id: Date.now().toString(),
fileName: newLink.assetName,
status: 'success',
message: `Linked to "${newLink.sequenceName}". Synced ${addedCount} comment ${addedCount === 1 ? 'marker' : 'markers'}.`,
})
}}
/>
{/* Toast Notification for Import Progress & Status */}
{importStatus && (
<div className={`shumai-import-toast ${importStatus.status}`}>
<div className="shumai-toast-left">
{importStatus.status === 'importing' && (
<ProgressCircle indeterminate size="s" label="Importing..." />
)}
{importStatus.status === 'success' && <StatusLight variant="positive"></StatusLight>}
{importStatus.status === 'error' && <StatusLight variant="negative"></StatusLight>}
<div className="shumai-toast-text">
<span className="shumai-toast-title">{importStatus.fileName}</span>
<span className="shumai-toast-msg">{importStatus.message}</span>
</div>
</div>
<sp-action-button
quiet
size="xs"
onClick={() => setImportStatus(null)}
title="Dismiss notification"
>
×
</sp-action-button>
</div>
)}
</div>
)
}
@@ -0,0 +1,154 @@
import React, { useEffect, useState } from 'react'
import { getShumaiClient } from '../api/client'
import { ProjectCard } from '../components/ProjectCard'
import { Button } from '@swc-react/button'
import { ProgressCircle } from '@swc-react/progress-circle'
import { IllustratedMessage } from '@swc-react/illustrated-message'
import { Divider } from '@swc-react/divider'
export interface ProjectSummary {
id: string
name: string
teamId: string
rootFolder?: string | null
coverImage?: string | null
updatedAt?: string | Date
}
interface ProjectsViewProps {
endpoint: string
apiKey: string
onSelectProject: (project: ProjectSummary) => void
}
export const ProjectsView: React.FC<ProjectsViewProps> = ({
endpoint,
apiKey,
onSelectProject,
}) => {
const [projects, setProjects] = useState<ProjectSummary[]>([])
const [loading, setLoading] = useState(true)
const [error, setError] = useState<string | null>(null)
const fetchProjects = async () => {
setLoading(true)
setError(null)
try {
const client = getShumaiClient(endpoint, apiKey)
const res = await client.api.projects.$get({
query: { first: '200', previewFormat: 'jpeg' },
})
if (!res.ok) {
const errData = (await res.json().catch(() => ({}))) as { error?: string }
throw new Error(errData.error || `Failed to fetch projects (${res.status})`)
}
const body = await res.json()
setProjects((body.data || []) as ProjectSummary[])
} catch (err) {
console.error('Error fetching projects:', err)
setError(err instanceof Error ? err.message : 'Failed to load projects.')
} finally {
setLoading(false)
}
}
useEffect(() => {
fetchProjects()
}, [endpoint, apiKey])
return (
<div
style={{
display: 'flex',
flexDirection: 'column',
flex: 1,
minHeight: 0,
overflow: 'hidden',
}}
>
{/* Sticky Title Bar */}
<div className="view-sticky-header">
<div
style={{
display: 'flex',
alignItems: 'center',
justifyContent: 'space-between',
marginBottom: '8px',
}}
>
<div style={{ display: 'flex', alignItems: 'center', gap: '6px' }}>
<h2 style={{ fontSize: '13px', fontWeight: 600 }}>Projects</h2>
{!loading && <span className="count-badge">{projects.length}</span>}
</div>
<sp-button
quiet
variant="secondary"
size="s"
label="Refresh projects"
icon-only
onClick={fetchProjects}
title="Refresh projects"
disabled={loading}
>
<sp-icon-refresh
slot="icon"
size="s"
className={loading ? 'spin' : ''}
></sp-icon-refresh>
</sp-button>
</div>
<Divider size="s" />
</div>
<div className="view-content">
{loading && (
<div className="state-container">
<ProgressCircle indeterminate size="m" label="Loading projects..." />
<p style={{ marginTop: '8px' }}>Loading projects...</p>
</div>
)}
{error && !loading && (
<div className="state-container">
<IllustratedMessage heading="Error loading projects" description={error}>
<sp-icon-alert-circle
size="xxl"
style={{ color: 'var(--accent-red)' }}
></sp-icon-alert-circle>
</IllustratedMessage>
<Button variant="secondary" onClick={fetchProjects} style={{ marginTop: '12px' }}>
Try Again
</Button>
</div>
)}
{!loading && !error && projects.length === 0 && (
<div className="state-container">
<IllustratedMessage
heading="No projects found"
description="Create a project in your Shumai workspace to get started."
>
<sp-icon-briefcase size="xxl" style={{ color: '#999999' }}></sp-icon-briefcase>
</IllustratedMessage>
</div>
)}
{!loading && !error && projects.length > 0 && (
<div className="project-card-list">
{projects.map((project) => (
<ProjectCard
key={project.id}
project={project}
endpoint={endpoint}
onClick={() => onSelectProject(project)}
/>
))}
</div>
)}
</div>
</div>
)
}
@@ -0,0 +1,253 @@
// @vitest-environment happy-dom
import React, { act } from 'react'
import { describe, it, expect, vi, afterEach, beforeEach } from 'vitest'
import { render, screen, fireEvent, cleanup } from '@testing-library/react'
import { SequencesView } from './SequencesView'
import type { Project, Sequence } from '@adobe/premierepro'
import * as premiereService from '../services/premiere'
import * as linkStorage from '../services/linkStorage'
import * as markersService from '../services/markers'
import type { CommentInfo } from '@shumai/dtos'
// Configure React 19 act environment for happy-dom
;(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true
describe('SequencesView Component', () => {
const mockOnLinkCountChange = vi.fn()
beforeEach(() => {
vi.restoreAllMocks()
})
afterEach(() => {
cleanup()
})
it('renders unified empty state when no sequences are linked', async () => {
const mockSeq = { guid: 'seq-1', name: 'Sequence 01' }
const mockProject = { guid: 'proj-1' }
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(mockSeq as unknown as Sequence)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([])
await act(async () => {
render(
<SequencesView
endpoint="https://api.shumai.test"
apiKey="test-key"
onLinkCountChange={mockOnLinkCountChange}
/>,
)
})
expect(screen.getByText('No Linked Sequences')).toBeDefined()
expect(screen.getByText(/Sequence 01/i)).toBeDefined()
expect(screen.queryByText('Browse Assets to Link')).toBeNull()
})
it('renders linked sequence card and handles unlink', async () => {
const mockSeq = { guid: 'seq-1', name: 'Sequence 01' }
const mockProject = { guid: 'proj-1' }
const mockLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Sequence 01',
assetId: 'asset-1',
assetName: 'final_edit.mp4',
syncedCommentIds: ['comm-1'],
lastSyncAt: Date.now(),
totalCommentsSynced: 1,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(mockSeq as unknown as Sequence)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([mockLink])
vi.spyOn(linkStorage, 'removeSequenceLink').mockResolvedValue(true)
await act(async () => {
render(
<SequencesView
endpoint="https://api.shumai.test"
apiKey="test-key"
onLinkCountChange={mockOnLinkCountChange}
/>,
)
})
expect(screen.getAllByText('Sequence 01').length).toBeGreaterThan(0)
expect(screen.getAllByText(/Asset: final_edit.mp4/i).length).toBeGreaterThan(0)
const unlinkButtons = screen.getAllByTitle('Unlink sequence')
expect(unlinkButtons.length).toBeGreaterThan(0)
await act(async () => {
fireEvent.click(unlinkButtons[0])
})
expect(linkStorage.removeSequenceLink).toHaveBeenCalledWith(mockProject, mockSeq)
})
it('filters out foreign endpoint links from the view and link count', async () => {
const mockSeq1 = { guid: 'seq-1', name: 'Sequence Foreign' }
const mockSeq2 = { guid: 'seq-2', name: 'Sequence Staging' }
const mockProject = { guid: 'proj-1' }
const foreignLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Sequence Foreign',
assetId: 'asset-dev',
assetName: 'dev_asset.mp4',
endpoint: 'http://localhost:3000',
syncedCommentIds: [],
lastSyncAt: Date.now(),
totalCommentsSynced: 0,
}
const stagingLink = {
sequenceGuid: 'seq-2',
sequenceName: 'Sequence Staging',
assetId: 'asset-staging',
assetName: 'staging_asset.mp4',
endpoint: 'https://staging.shumai.one',
syncedCommentIds: [],
lastSyncAt: Date.now(),
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(
mockSeq1 as unknown as Sequence,
)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([
mockSeq1 as unknown as Sequence,
mockSeq2 as unknown as Sequence,
])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([foreignLink, stagingLink])
await act(async () => {
render(
<SequencesView
endpoint="https://staging.shumai.one"
apiKey="staging-key"
onLinkCountChange={mockOnLinkCountChange}
/>,
)
})
// Foreign link should be completely hidden
expect(screen.queryByText('dev_asset.mp4')).toBeNull()
expect(screen.queryByText(/Server:/i)).toBeNull()
// Matching link should be visible
expect(screen.getAllByText(/staging_asset.mp4/i).length).toBeGreaterThan(0)
// Active sequence (seq-1) is linked to foreign server, so current sequence card should show unlinked state
expect(screen.getByText('This sequence is not linked to any Shumai asset.')).toBeDefined()
// Link count reported to parent should only count staging link (1)
expect(mockOnLinkCountChange).toHaveBeenCalledWith(1)
})
it('shows error toast when manual sync fails', async () => {
const mockSeq = { guid: 'seq-1', name: 'Sequence 01' }
const mockProject = { guid: 'proj-1' }
const mockLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Sequence 01',
assetId: 'asset-missing',
assetName: 'missing.mp4',
endpoint: 'https://staging.shumai.one',
syncedCommentIds: [],
lastSyncAt: Date.now(),
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(mockSeq as unknown as Sequence)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([mockLink])
vi.spyOn(markersService, 'fetchAssetComments').mockRejectedValue(
new Error('Asset not found on this server (HTTP 404)'),
)
await act(async () => {
render(
<SequencesView
endpoint="https://staging.shumai.one"
apiKey="staging-key"
onLinkCountChange={mockOnLinkCountChange}
/>,
)
})
const syncButtons = screen.getAllByTitle('Sync comments now')
expect(syncButtons[0].hasAttribute('disabled')).toBe(false)
await act(async () => {
fireEvent.click(syncButtons[0])
})
expect(markersService.fetchAssetComments).toHaveBeenCalledWith(
'https://staging.shumai.one',
'staging-key',
'asset-missing',
)
expect(screen.getByText('Asset not found on this server (HTTP 404)')).toBeDefined()
})
it('shows success toast when manual sync succeeds', async () => {
const mockSeq = { guid: 'seq-1', name: 'Sequence 01' }
const mockProject = { guid: 'proj-1' }
const mockLink = {
sequenceGuid: 'seq-1',
sequenceName: 'Sequence 01',
assetId: 'asset-1',
assetName: 'final.mp4',
endpoint: 'https://staging.shumai.one',
syncedCommentIds: [],
lastSyncAt: Date.now(),
totalCommentsSynced: 0,
}
vi.spyOn(premiereService, 'getActiveProject').mockResolvedValue(
mockProject as unknown as Project,
)
vi.spyOn(premiereService, 'getActiveSequence').mockResolvedValue(mockSeq as unknown as Sequence)
vi.spyOn(premiereService, 'getAllSequences').mockResolvedValue([mockSeq as unknown as Sequence])
vi.spyOn(linkStorage, 'getAllLinkedSequences').mockResolvedValue([mockLink])
vi.spyOn(markersService, 'fetchAssetComments').mockResolvedValue([
{ id: 'comm-1', second: 10, message: 'Fix color' } as unknown as CommentInfo,
])
vi.spyOn(markersService, 'syncCommentsToSequence').mockResolvedValue({
updatedLink: { ...mockLink, syncedCommentIds: ['comm-1'], totalCommentsSynced: 1 },
addedCount: 1,
})
await act(async () => {
render(
<SequencesView
endpoint="https://staging.shumai.one"
apiKey="staging-key"
onLinkCountChange={mockOnLinkCountChange}
/>,
)
})
const syncButtons = screen.getAllByTitle('Sync comments now')
await act(async () => {
fireEvent.click(syncButtons[0])
})
expect(screen.getByText('Synced 1 new comment marker for "Sequence 01".')).toBeDefined()
})
})
@@ -0,0 +1,524 @@
import React, { useState, useEffect, useCallback } from 'react'
import type { Project, Sequence } from '@adobe/premierepro'
import type { LinkedSequenceAsset } from '../types/link'
import {
getActiveProject,
getActiveSequence,
getAllSequences,
openSequenceInTimeline,
getPremiereModule,
} from '../services/premiere'
import { getAllLinkedSequences, normalizeGuid, removeSequenceLink } from '../services/linkStorage'
import { fetchAssetComments, syncCommentsToSequence } from '../services/markers'
import { resolveAssetUrl, isSameEndpoint } from '../utils/url'
import { formatDateAgo } from '../utils/date'
import { ProgressCircle } from '@swc-react/progress-circle'
export interface SequencesViewProps {
endpoint: string
apiKey: string
onLinkCountChange?: (count: number) => void
}
export const SequencesView: React.FC<SequencesViewProps> = ({
endpoint,
apiKey,
onLinkCountChange,
}) => {
const [project, setProject] = useState<Project | null>(null)
const [activeSeq, setActiveSeq] = useState<Sequence | null>(null)
const [allSeqs, setAllSeqs] = useState<Sequence[]>([])
const [linkedSequences, setLinkedSequences] = useState<LinkedSequenceAsset[]>([])
const [loading, setLoading] = useState(true)
const [syncingGuid, setSyncingGuid] = useState<string | null>(null)
const [unlinkingGuid, setUnlinkingGuid] = useState<string | null>(null)
const [toast, setToast] = useState<{ type: 'success' | 'error'; message: string } | null>(null)
const loadData = useCallback(async () => {
try {
const pr = await getActiveProject()
setProject(pr)
if (!pr) {
setActiveSeq(null)
setAllSeqs([])
setLinkedSequences([])
onLinkCountChange?.(0)
return
}
const [currentActive, seqsList] = await Promise.all([
getActiveSequence(pr),
getAllSequences(pr),
])
setActiveSeq(currentActive)
setAllSeqs(seqsList)
const allLinks = await getAllLinkedSequences(pr, seqsList)
// Hide foreign links entirely: only show sequences linked to the current endpoint
const currentServerLinks = allLinks.filter(
(link) => !link.endpoint || isSameEndpoint(link.endpoint, endpoint),
)
setLinkedSequences(currentServerLinks)
onLinkCountChange?.(currentServerLinks.length)
} catch (err) {
console.error('[SequencesView] Failed to load sequences data:', err)
} finally {
setLoading(false)
}
}, [endpoint, onLinkCountChange])
useEffect(() => {
void loadData()
// Listen for sequence activation events in Premiere Pro
const ppro = getPremiereModule()
if (ppro?.EventManager && ppro.Constants?.SequenceEvent?.ACTIVATED) {
const handleActivated = () => {
void loadData()
}
try {
ppro.EventManager.addGlobalEventListener(
ppro.Constants.SequenceEvent.ACTIVATED,
handleActivated,
true,
)
return () => {
try {
ppro.EventManager.removeGlobalEventListener(
ppro.Constants.SequenceEvent.ACTIVATED,
handleActivated,
)
} catch {
// Ignore error on unmount
}
}
} catch (err) {
console.warn('[SequencesView] Could not add SequenceEvent listener:', err)
}
}
}, [loadData])
const showToast = (type: 'success' | 'error', message: string, duration = 4000) => {
setToast({ type, message })
setTimeout(() => {
setToast((prev) => (prev?.message === message ? null : prev))
}, duration)
}
// Sync Now handler
const handleSyncNow = async (link: LinkedSequenceAsset) => {
if (!project || syncingGuid) return
if (link.endpoint && !isSameEndpoint(link.endpoint, endpoint)) {
showToast(
'error',
`Cannot sync comments: sequence was linked to "${link.endpoint}". Connect to that server to sync.`,
5000,
)
return
}
const targetSeq =
allSeqs.find((s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid)) ||
(await getAllSequences(project)).find(
(s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid),
)
if (!targetSeq) return
setSyncingGuid(link.sequenceGuid)
try {
const comments = await fetchAssetComments(endpoint, apiKey, link.assetId)
const { updatedLink, addedCount } = await syncCommentsToSequence(
project,
targetSeq,
comments,
link,
)
setLinkedSequences((prev) =>
prev.map((item) =>
normalizeGuid(item.sequenceGuid) === normalizeGuid(updatedLink.sequenceGuid)
? updatedLink
: item,
),
)
showToast(
'success',
addedCount > 0
? `Synced ${addedCount} new comment ${addedCount === 1 ? 'marker' : 'markers'} for "${link.sequenceName}".`
: `All comments are already synced for "${link.sequenceName}".`,
)
} catch (err) {
console.error('[SequencesView] Failed to sync comments:', err)
showToast(
'error',
err instanceof Error ? err.message : 'Failed to sync comments from server.',
5000,
)
} finally {
setSyncingGuid(null)
}
}
// Unlink handler
const handleUnlink = async (link: LinkedSequenceAsset) => {
if (!project || unlinkingGuid) return
const targetSeq =
allSeqs.find((s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid)) ||
(await getAllSequences(project)).find(
(s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid),
)
if (!targetSeq) return
setUnlinkingGuid(link.sequenceGuid)
try {
await removeSequenceLink(project, targetSeq)
setLinkedSequences((prev) => {
const next = prev.filter(
(item) => normalizeGuid(item.sequenceGuid) !== normalizeGuid(link.sequenceGuid),
)
onLinkCountChange?.(next.length)
return next
})
showToast('success', `Unlinked "${link.sequenceName}" from "${link.assetName}".`, 3000)
} catch (err) {
console.error('[SequencesView] Failed to unlink sequence:', err)
showToast('error', 'Failed to unlink sequence.', 4000)
} finally {
setUnlinkingGuid(null)
}
}
// Open Sequence in Timeline handler
const handleOpenSequence = async (link: LinkedSequenceAsset) => {
if (!project) return
const targetSeq =
allSeqs.find((s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid)) ||
(await getAllSequences(project)).find(
(s) => normalizeGuid(s.guid) === normalizeGuid(link.sequenceGuid),
)
if (!targetSeq) return
await openSequenceInTimeline(targetSeq, project)
setActiveSeq(targetSeq)
}
const renderToast = () => {
if (!toast) return null
const isError = toast.type === 'error'
return (
<div
style={{
marginBottom: 10,
padding: '6px 10px',
borderRadius: 4,
backgroundColor: isError ? 'rgba(239, 68, 68, 0.15)' : 'rgba(59, 130, 246, 0.15)',
border: isError
? '1px solid rgba(239, 68, 68, 0.3)'
: '1px solid rgba(59, 130, 246, 0.3)',
color: isError ? '#f87171' : '#60a5fa',
fontSize: 11,
display: 'flex',
alignItems: 'center',
}}
>
{isError ? (
<sp-icon-alert-circle
size="s"
style={{ marginRight: 6, flexShrink: 0 }}
></sp-icon-alert-circle>
) : (
<sp-icon-checkmark-circle
size="s"
style={{ marginRight: 6, flexShrink: 0 }}
></sp-icon-checkmark-circle>
)}
<span>{toast.message}</span>
</div>
)
}
if (loading) {
return (
<div
className="sequences-view-container"
style={{ justifyContent: 'center', alignItems: 'center' }}
>
<ProgressCircle indeterminate size="m" label="Loading sequences..." />
</div>
)
}
const activeGuidStr = normalizeGuid(activeSeq?.guid)
const currentSequenceLink = linkedSequences.find(
(item) => normalizeGuid(item.sequenceGuid) === activeGuidStr,
)
if (linkedSequences.length === 0) {
return (
<div className="sequences-view-container sequences-empty-container">
{renderToast()}
<div className="sequence-empty-state unified-empty">
<sp-icon-movie-camera
size="xxl"
style={{ color: '#60a5fa', opacity: 0.7, marginBottom: 12 }}
></sp-icon-movie-camera>
<div className="sequence-empty-state-title" style={{ fontSize: 14, marginBottom: 6 }}>
No Linked Sequences
</div>
<div style={{ fontSize: 11, marginBottom: 8, maxWidth: 280, lineHeight: 1.4 }}>
{activeSeq
? `Active sequence "${activeSeq.name}" is not linked to any Shumai asset.`
: 'Open a sequence in Premiere Pro and link it to a Shumai asset.'}
</div>
<div
style={{
fontSize: 11,
color: 'var(--text-secondary)',
marginBottom: 0,
maxWidth: 280,
lineHeight: 1.4,
}}
>
Linking a sequence enables automatic synchronization of comments from Shumai as timeline
markers.
</div>
</div>
</div>
)
}
return (
<div className="sequences-view-container">
{/* Toast Notification */}
{renderToast()}
{/* SECTION 1: Current Sequence Asset */}
<div className="sequence-section">
<div className="sequence-section-title">Current Sequence Asset</div>
{currentSequenceLink ? (
<div className="sequence-link-card current-active">
<div className="sequence-card-row">
<div className="sequence-card-left">
<div className="sequence-card-thumb">
{currentSequenceLink.assetThumbnailUrl ? (
<img
src={resolveAssetUrl(
currentSequenceLink.assetThumbnailUrl,
currentSequenceLink.endpoint || endpoint,
)}
alt={currentSequenceLink.assetName}
/>
) : (
<sp-icon-movie-camera
size="m"
style={{ color: '#3b82f6' }}
></sp-icon-movie-camera>
)}
</div>
<div className="sequence-card-info">
<div style={{ display: 'flex', alignItems: 'center' }}>
<span className="sequence-card-title">{currentSequenceLink.sequenceName}</span>
<span
style={{
fontSize: '9px',
marginLeft: 6,
padding: '1px 4px',
borderRadius: 3,
backgroundColor: 'rgba(59, 130, 246, 0.2)',
color: '#60a5fa',
fontWeight: 600,
}}
>
Active
</span>
</div>
<span className="sequence-card-subtitle" title={currentSequenceLink.assetName}>
Asset: {currentSequenceLink.assetName}
</span>
</div>
</div>
<div className="sequence-card-actions">
<sp-action-button
quiet
size="xs"
label="Sync comments now"
title="Sync comments now"
disabled={syncingGuid === currentSequenceLink.sequenceGuid}
onClick={() => handleSyncNow(currentSequenceLink)}
>
{syncingGuid === currentSequenceLink.sequenceGuid ? (
<ProgressCircle indeterminate size="s" slot="icon" label="Syncing..." />
) : (
<sp-icon-refresh size="s" slot="icon"></sp-icon-refresh>
)}
</sp-action-button>
<sp-action-button
quiet
size="xs"
label="Unlink sequence"
title="Unlink sequence"
disabled={unlinkingGuid === currentSequenceLink.sequenceGuid}
onClick={() => handleUnlink(currentSequenceLink)}
>
{unlinkingGuid === currentSequenceLink.sequenceGuid ? (
<ProgressCircle indeterminate size="s" slot="icon" label="Unlinking..." />
) : (
<sp-icon-unlink
size="s"
slot="icon"
style={{ color: '#f87171' }}
></sp-icon-unlink>
)}
</sp-action-button>
</div>
</div>
<div className="sequence-card-footer">
<span>
{currentSequenceLink.totalCommentsSynced}{' '}
{currentSequenceLink.totalCommentsSynced === 1 ? 'comment' : 'comments'} synced
</span>
<span>Last sync: {formatDateAgo(currentSequenceLink.lastSyncAt) || 'Just now'}</span>
</div>
</div>
) : (
<div className="sequence-empty-state compact">
<sp-icon-movie-camera
size="l"
style={{ color: '#60a5fa', opacity: 0.6, marginBottom: 4 }}
></sp-icon-movie-camera>
<div className="sequence-empty-state-title">
{activeSeq ? activeSeq.name : 'No Active Sequence'}
</div>
<div style={{ fontSize: 11, color: 'var(--text-secondary)', marginBottom: 8 }}>
{activeSeq
? 'This sequence is not linked to any Shumai asset.'
: 'Open a sequence in the timeline to view its linked asset.'}
</div>
</div>
)}
</div>
{/* SECTION 2: All Sequence Assets */}
<div className="sequence-section" style={{ marginTop: 8 }}>
<div className="sequence-section-title">All Sequence Assets ({linkedSequences.length})</div>
{linkedSequences.map((link) => {
const isActive = normalizeGuid(link.sequenceGuid) === activeGuidStr
const isSyncing = syncingGuid === link.sequenceGuid
const isUnlinking = unlinkingGuid === link.sequenceGuid
return (
<div
key={link.sequenceGuid}
className={`sequence-link-card ${isActive ? 'current-active' : ''}`}
>
<div className="sequence-card-row">
<div className="sequence-card-left">
<div className="sequence-card-thumb">
{link.assetThumbnailUrl ? (
<img
src={resolveAssetUrl(link.assetThumbnailUrl, link.endpoint || endpoint)}
alt={link.assetName}
/>
) : (
<sp-icon-movie-camera
size="m"
style={{ color: '#60a5fa' }}
></sp-icon-movie-camera>
)}
</div>
<div className="sequence-card-info">
<div style={{ display: 'flex', alignItems: 'center' }}>
<span className="sequence-card-title">{link.sequenceName}</span>
{isActive && (
<span
style={{
fontSize: '9px',
marginLeft: 6,
padding: '1px 4px',
borderRadius: 3,
backgroundColor: 'rgba(59, 130, 246, 0.2)',
color: '#60a5fa',
fontWeight: 600,
}}
>
Active
</span>
)}
</div>
<span className="sequence-card-subtitle" title={link.assetName}>
Asset: {link.assetName}
</span>
</div>
</div>
<div className="sequence-card-actions">
{!isActive && (
<sp-action-button
quiet
size="xs"
label="Open sequence in timeline"
title="Open sequence in timeline"
onClick={() => handleOpenSequence(link)}
>
<sp-icon-link-out size="s" slot="icon"></sp-icon-link-out>
</sp-action-button>
)}
<sp-action-button
quiet
size="xs"
label="Sync comments now"
title="Sync comments now"
disabled={isSyncing}
onClick={() => handleSyncNow(link)}
>
{isSyncing ? (
<ProgressCircle indeterminate size="s" slot="icon" label="Syncing..." />
) : (
<sp-icon-refresh size="s" slot="icon"></sp-icon-refresh>
)}
</sp-action-button>
<sp-action-button
quiet
size="xs"
label="Unlink sequence"
title="Unlink sequence"
disabled={isUnlinking}
onClick={() => handleUnlink(link)}
>
{isUnlinking ? (
<ProgressCircle indeterminate size="s" slot="icon" label="Unlinking..." />
) : (
<sp-icon-unlink
size="s"
slot="icon"
style={{ color: '#f87171' }}
></sp-icon-unlink>
)}
</sp-action-button>
</div>
</div>
<div className="sequence-card-footer">
<span>
{link.totalCommentsSynced}{' '}
{link.totalCommentsSynced === 1 ? 'comment' : 'comments'} synced
</span>
<span>Last sync: {formatDateAgo(link.lastSyncAt) || 'Just now'}</span>
</div>
</div>
)
})}
</div>
</div>
)
}
+9
View File
@@ -0,0 +1,9 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"jsx": "react-jsx",
"jsxImportSource": "react",
"types": ["bun", "node", "@adobe/premierepro"]
},
"include": ["src/**/*"]
}
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@shumai/transcode-app",
"version": "0.0.9",
"version": "0.4.7",
"private": true,
"type": "module",
"bin": {
+118
View File
@@ -0,0 +1,118 @@
# Web App E2E Tests
Fullstack end-to-end tests for the Shumai web app. They run against a real backend
(pgvector container + local S3 storage) served on `http://localhost:5200` and are
executed with Playwright via `bun run test:e2e:app`.
## Structure
```
apps/web/e2e/
├── fixtures.ts # prisma / owner / project / file fixtures
├── serve.ts # starts the test DB container + web app
├── global-teardown.ts # stops the container and cleans up storage
├── helpers/
│ ├── auth.ts # signup / auth-state injection helpers
│ ├── project.ts # project creation helpers
│ ├── files.ts # share link API helpers
│ ├── team.ts # team member seeding helpers
│ └── ui.ts # common UI flows (signup, login, members dialog)
└── tests/<domain>/ # domain-scoped specs (auth, team, project)
```
## Fixtures
- `prisma` — auto fixture that truncates all tables before each test. Also the
direct way to read/write DB state for assertions and seeding.
- `owner` — an authenticated team owner (seeded through the API), with the session
cookie and auth state injected into the browser context, opened on the team page.
- `project` — `owner` plus a project created through the API (`projectId`,
`projectName`).
- `file` — `project` plus a seeded processed file asset in the project root
(`fileId`, `fileName`). The media kind is configurable per test via
`fileOptions` (default `binary`):
```ts
// default binary file (no extension, no proxy)
test('...', async ({ file }) => {})
// type-scoped file for future viewer/transcode tests
test('...', { fileOptions: { mediaType: 'image' } }, async ({ file }) => {})
```
| mediaType | filename | notes |
|---|---|---|
| `binary` (default) | `test-file-<ts>` | never transcoded, no proxy |
| `text` | `test-file-<ts>.txt` | gets a PDF proxy in real usage |
| `image` | `test-file-<ts>.png` | |
| `video` | `test-file-<ts>.mp4` | |
| `pdf` | `test-file-<ts>.pdf` | |
| `audio` | `test-file-<ts>.wav` | |
## Test Cases
### auth
| Test | File |
|---|---|
| Sign up as the first user and become the team owner | `tests/auth/signup.spec.ts` |
| Log in with existing credentials | `tests/auth/login.spec.ts` |
| Show error when accessing reset-password page without token | `tests/auth/reset-password.spec.ts` |
| Reset password with valid token and allow logging in with new password | `tests/auth/reset-password.spec.ts` |
### team
| Test | File |
|---|---|
| Owner invites a member via invite link and the invitee joins | `tests/team/invite-member.spec.ts` |
| Owner removes a member via the members dialog; the membership is deleted from the DB | `tests/team/remove-member.spec.ts` |
| Owner changes a team member role in the members dialog and permissions update | `tests/team/change-member-role.spec.ts` |
| Owner manages resource quotas in settings and resets usage from the dashboard | `tests/team/quotas-settings.spec.ts` |
### project
| Test | File |
|---|---|
| Owner creates a project with a cover image | `tests/project/create-project.spec.ts` |
| Owner uploads a file or an unsupported file via the "Upload File" context menu action | `tests/project/upload-file.spec.ts` |
| Owner deletes a file, finds it in recently deleted, and restores it | `tests/project/delete-restore.spec.ts` |
| Owner deletes a folder and still sees its contents preview and countdown in recently deleted | `tests/project/delete-restore.spec.ts` |
| Owner deletes a version stack and restores it from recently deleted | `tests/project/delete-restore.spec.ts` |
| Owner creates a share link from a file context menu and lands on the share page | `tests/project/create-share-link.spec.ts` |
| Owner protects a share with a password; guests must enter it to view | `tests/project/share-password.spec.ts` |
| Owner creates a collection from the sidebar; the collection shows project files | `tests/project/create-collection.spec.ts` |
| Owner invites a member to a project; the member only sees the invited project | `tests/project/invite-member.spec.ts` |
| Owner changes a project member role in the members dialog and permissions update | `tests/project/change-member-role.spec.ts` |
| Owner adds team member to project with role override and permissions enforce project role | `tests/project/role-override.spec.ts` |
| Owner deletes a member from project via the members dialog and project access is revoked | `tests/project/remove-member.spec.ts` |
| Owner drags a file into a folder and a folder into another folder | `tests/project/move-folder-file.spec.ts` |
| Owner drags a file onto a file to create a version stack | `tests/project/version-stack-create.spec.ts` |
| Owner drags a file onto a version stack to add a new version | `tests/project/version-stack-add-version.spec.ts` |
| Owner manages version stack: removes version from 3-version stack | `tests/project/version-stack-manage.spec.ts` |
| Owner removes version from 2-version stack which dissolves into standalone files | `tests/project/version-stack-manage.spec.ts` |
| Dissolving a shared version stack renders the remaining standalone file name on the share page | `tests/project/version-stack-manage.spec.ts` |
| Moving a shared file into a shared version stack leaves only 1 stack card on the share page | `tests/project/version-stack-manage.spec.ts` |
| Owner searches the file list by an English name keyword | `tests/project/search-file-list.spec.ts` |
| Owner searches the file list by Chinese, Japanese, and Korean name keywords | `tests/project/search-file-list.spec.ts` |
| Owner searches the file list with a keyword and a filter condition | `tests/project/search-file-list.spec.ts` |
| Owner saves a search result as a collection | `tests/project/save-search-collection.spec.ts` |
| Image share with watermark + download disabled: no download buttons on public list/detail pages, watermarked proxy served, download-url rejected | `tests/project/share-watermark-no-download.spec.ts` |
| Video share with watermark + download disabled: no download buttons on public list/detail pages, watermarked proxy served, download-url rejected | `tests/project/share-watermark-no-download.spec.ts` |
| Owner views a file and it appears in recents | `tests/project/recents.spec.ts` |
### file
| Test | File |
|---|---|
| Create a comment on a binary file | `tests/file/binary-comment.spec.ts` |
| Upload a txt file, wait for transcode, and create a comment with draw | `tests/file/txt-draw-comment.spec.ts` |
| Upload an image file, wait for transcode, and create a comment with draw | `tests/file/image-draw-comment.spec.ts` |
| Upload a video file, wait for transcode, and create a comment with draw at a non-zero timestamp | `tests/file/video-draw-comment.spec.ts` |
| Upload an audio file, wait for transcode, and create a comment at a non-zero timestamp | `tests/file/audio-timestamp-comment.spec.ts` |
| Show a breathing poster preview and "Preparing..." while a video is still transcoding | `tests/file/processing-preview.spec.ts` |
| Show a preparing circle before the poster is generated | `tests/file/processing-preview.spec.ts` |
## Conventions
- Seed data via fixtures/API/DB; use the UI only for the flow under test.
- Each test truncates all tables via the auto `prisma` fixture, so fixtures must
create their data per-test.
- App projects run with `workers: 1` because all tests share a single database.
- Every new test case MUST be documented in this README.
+197
View File
@@ -0,0 +1,197 @@
import { test as base } from '@playwright/test'
import type { BrowserContext, Page } from '@playwright/test'
import { PrismaClient } from '../../../packages/db/src/generated/prisma/client'
import { PrismaPg } from '@prisma/adapter-pg'
import { Pool } from 'pg'
import * as fs from 'fs'
import * as path from 'path'
import { fileURLToPath } from 'url'
import {
E2E_APP_URL,
E2E_PASSWORD,
apiSignup,
injectAuthState,
resolveTeamId,
uniqueEmail,
} from './helpers/auth'
import { apiCreateProject, uniqueProjectName } from './helpers/project'
import { apiUploadFile } from './helpers/files'
const currentDir = path.dirname(fileURLToPath(import.meta.url))
const envPath = path.resolve(currentDir, '.env.e2e')
const fixturesDir = path.resolve(currentDir, '../../../packages/e2e/fixtures')
function loadEnv() {
if (fs.existsSync(envPath)) {
const content = fs.readFileSync(envPath, 'utf8')
content.split('\n').forEach((line) => {
const parts = line.split('=')
if (parts.length >= 2) {
const key = parts[0].trim()
const value = parts.slice(1).join('=').trim()
process.env[key] = value
}
})
}
}
// Load E2E environment variables if present
loadEnv()
export interface OwnerFixture {
/** Page opened in a browser context logged in as the team owner. */
page: Page
context: BrowserContext
teamId: string
email: string
password: string
}
export interface ProjectFixture extends OwnerFixture {
projectId: string
projectName: string
/** The project's root folder asset id. */
rootFolderId: string
}
/** The media kind of a seeded test file. */
export type FileMediaType = 'text' | 'binary' | 'image' | 'video' | 'pdf' | 'audio'
export interface FileFixtureOptions {
/** Defaults to `binary` (no extension, never transcoded, no proxy). */
mediaType?: FileMediaType
}
export interface FileFixture extends ProjectFixture {
fileId: string
fileName: string
fileMediaType: FileMediaType
}
const FILE_TYPE_MAP: Record<FileMediaType, { ext: string; mime: string }> = {
text: { ext: 'txt', mime: 'text/plain' },
binary: { ext: '', mime: 'application/octet-stream' },
image: { ext: 'png', mime: 'image/png' },
video: { ext: 'mp4', mime: 'video/mp4' },
pdf: { ext: 'pdf', mime: 'application/pdf' },
audio: { ext: 'wav', mime: 'audio/wav' },
}
function getFileBuffer(mediaType: FileMediaType): Buffer {
switch (mediaType) {
case 'image':
return fs.readFileSync(path.join(fixturesDir, 'small.png'))
case 'video':
return fs.readFileSync(path.join(fixturesDir, 'small.mp4'))
case 'audio':
return fs.readFileSync(path.join(fixturesDir, 'small.wav'))
case 'pdf':
return fs.readFileSync(path.join(fixturesDir, 'test.pdf'))
case 'text':
return Buffer.from(
'Sample text content for PDF proxy transcode test.\nSecond line of text content.',
)
case 'binary':
default:
return Buffer.from('binary-file-content-sample')
}
}
export const test = base.extend<{
prisma: PrismaClient
owner: OwnerFixture
project: ProjectFixture
fileOptions: FileFixtureOptions
file: FileFixture
}>({
fileOptions: [{ mediaType: 'binary' }, { option: true }],
prisma: [
// eslint-disable-next-line no-empty-pattern
async ({}, use) => {
loadEnv()
const connectionString = process.env.DATABASE_URL
const pool = new Pool({ connectionString })
const adapter = new PrismaPg(pool)
const prisma = new PrismaClient({ adapter })
// Reset database state before the test runs
await prisma.$executeRawUnsafe(`
DO $$ DECLARE
r RECORD;
BEGIN
FOR r IN (SELECT tablename FROM pg_tables WHERE schemaname = 'public' AND tablename <> '_prisma_migrations') LOOP
EXECUTE 'TRUNCATE TABLE ' || quote_ident(r.tablename) || ' CASCADE;';
END LOOP;
END $$;
`)
// Provide the clean prisma instance to the test
await use(prisma)
// Disconnect and clean up resources after the test finishes
await prisma.$disconnect()
await pool.end()
},
{ auto: true },
],
/**
* Sets up an authenticated team owner through the API (fast, no UI): creates
* the user, stores the session cookie in the browser context, injects the
* persisted auth state, and opens the team page.
*/
owner: async ({ browser }, use) => {
const context = await browser.newContext({
// eslint-disable-next-line @typescript-eslint/naming-convention
baseURL: E2E_APP_URL,
})
const email = uniqueEmail('owner')
const password = E2E_PASSWORD
try {
// Create the owner via the API so the session cookie lands in the context
const user = await apiSignup(context.request, email, password)
await injectAuthState(context, user)
const teamId = await resolveTeamId(context.request)
// Open the app already logged in on the team page
const page = await context.newPage()
await page.goto(`/teams/${teamId}`)
await use({ page, context, teamId, email, password })
} finally {
await context.close()
}
},
/** Sets up an authenticated team owner plus a project created via the API. */
project: async ({ owner, prisma }, use) => {
const name = uniqueProjectName()
const project = await apiCreateProject(owner.context.request, owner.teamId, name)
const projectRow = await prisma.project.findUnique({ where: { id: project.id } })
const rootFolderId = projectRow?.rootFolderId
if (!rootFolderId) throw new Error('Project has no root folder')
await use({ ...owner, projectId: project.id, projectName: name, rootFolderId })
},
/**
* Sets up an owner + project with an uploaded file asset under the
* project root folder via the API upload task endpoints. The media type is configurable per test via
* `fileOptions` (defaults to `binary`).
*/
file: async ({ project, fileOptions }, use) => {
const mediaType: FileMediaType = fileOptions.mediaType ?? 'binary'
const { ext, mime } = FILE_TYPE_MAP[mediaType]
const fileName = `test-file-${Date.now()}${ext ? `.${ext}` : ''}`
const buffer = getFileBuffer(mediaType)
const uploaded = await apiUploadFile(
project.context.request,
project.teamId,
project.rootFolderId,
fileName,
mime,
buffer,
)
await use({ ...project, fileId: uploaded.fileId, fileName, fileMediaType: mediaType })
},
})
export { expect } from '@playwright/test'
+36
View File
@@ -0,0 +1,36 @@
import { teardown as dbTeardown } from '../../../packages/db/src/test-global-setup'
import * as fs from 'fs'
import * as path from 'path'
import { fileURLToPath } from 'url'
const currentDir = path.dirname(fileURLToPath(import.meta.url))
export default async function globalTeardown() {
const envPath = path.resolve(currentDir, '.env.e2e')
if (fs.existsSync(envPath)) {
const content = fs.readFileSync(envPath, 'utf8')
let bucketName: string | undefined
content.split('\n').forEach((line) => {
const parts = line.split('=')
if (parts.length >= 2 && parts[0].trim() === 'S3_BUCKET') {
bucketName = parts.slice(1).join('=').trim()
}
})
if (bucketName) {
const bucketDir = path.resolve('data', bucketName)
if (fs.existsSync(bucketDir)) {
console.log(`Cleaning up E2E local storage bucket: ${bucketDir}`)
fs.rmSync(bucketDir, { recursive: true, force: true })
}
}
// Delete the temp .env.e2e file
fs.unlinkSync(envPath)
}
// Stop pgvector container
await dbTeardown()
console.log('Global teardown complete.')
}
+31
View File
@@ -0,0 +1,31 @@
import type { PrismaClient } from '../../../../packages/db/src/generated/prisma/client'
/**
* Seeds a folder asset directly through the database (fast, no UI). The folder
* is placed under `parentId` (usually a project's root folder).
*/
export async function seedFolder(
prisma: PrismaClient,
projectId: string,
parentId: string,
name: string,
) {
return prisma.asset.create({
data: { name, type: 'folder', status: 'processed', projectId, parentId },
})
}
/**
* Seeds a processed file asset directly through the database (fast, no UI).
* The file is placed under `parentId` (a folder or a version stack).
*/
export async function seedFile(
prisma: PrismaClient,
projectId: string,
parentId: string,
name: string,
) {
return prisma.asset.create({
data: { name, type: 'file', status: 'processed', sizeByte: 10, projectId, parentId },
})
}
+76
View File
@@ -0,0 +1,76 @@
import type { APIRequestContext, BrowserContext } from '@playwright/test'
/** Base URL of the fullstack app under test (must match playwright.config.ts). */
export const E2E_APP_URL = process.env.E2E_APP_URL || 'http://localhost:5200'
export const E2E_PASSWORD = 'Password123!'
export function uniqueEmail(prefix = 'user'): string {
return `${prefix}-${Date.now()}-${Math.random().toString(36).slice(2, 8)}@shumai.local`
}
export interface AuthUser {
id: string
email: string
name: string
}
interface SignupResponse {
token?: string | null
user?: AuthUser
error?: { message?: string } | null
}
/**
* Creates a user through the better-auth API.
* When passed a `context.request`, the session cookie is stored in the browser
* context and the user is logged in.
*/
export async function apiSignup(
request: APIRequestContext,
email: string,
password: string,
options: { inviteCode?: string } = {},
): Promise<AuthUser> {
const res = await request.post('/api/auth/sign-up/email', {
data: {
name: email,
email,
password,
...(options.inviteCode ? { inviteCode: options.inviteCode } : {}),
},
})
if (!res.ok()) {
throw new Error(`Signup API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as SignupResponse
if (!body.user) {
throw new Error(`Signup API returned no user: ${JSON.stringify(body)}`)
}
return body.user
}
/**
* Injects the persisted auth state (zustand `auth-storage`) so the app
* considers the session logged in. The session cookie must already be present
* in the context (created via `context.request`).
*/
export async function injectAuthState(context: BrowserContext, user: AuthUser): Promise<void> {
await context.addInitScript((u) => {
localStorage.setItem('auth-storage', JSON.stringify({ state: { user: u }, version: 0 }))
}, user)
}
/** Resolves the id of the first team for the authenticated request context. */
export async function resolveTeamId(request: APIRequestContext): Promise<string> {
const res = await request.get('/api/teams')
if (!res.ok()) {
throw new Error(`GET /api/teams failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as { data: { id: string }[] }
const teamId = body.data?.[0]?.id
if (!teamId) {
throw new Error(`No team found in /api/teams response: ${JSON.stringify(body)}`)
}
return teamId
}
+55
View File
@@ -0,0 +1,55 @@
import type { Locator, Page } from '@playwright/test'
/**
* Performs a pointer drag from one card to another. dnd-kit v6 uses a
* `PointerSensor` with a 10px distance activation constraint, and WebKit only
* reliably starts the drag when pointer moves are delivered in separate,
* awaited batches (a single fast `mouse.move(steps)` can be coalesced before
* the drag activates, losing the drop). Moves are therefore chunked with
* intermediate waits so the activation and drag move handlers run between
* batches on every browser.
*/
export async function dragCard(page: Page, source: Locator, target: Locator): Promise<void> {
const sourceBox = (await source.boundingBox())!
const targetBox = (await target.boundingBox())!
if (!sourceBox || !targetBox) {
throw new Error('Drag source or target has no bounding box')
}
const fromX = sourceBox.x + sourceBox.width / 2
const fromY = sourceBox.y + sourceBox.height / 2
const toX = targetBox.x + targetBox.width / 2
const toY = targetBox.y + targetBox.height / 2
await page.mouse.move(fromX, fromY)
await page.mouse.down()
const dx = toX - fromX
const dy = toY - fromY
const dist = Math.hypot(dx, dy)
// Step past the 10px activation constraint to trigger drag activation
// and give the browser a brief moment for status to become 'dragging'
const activationRatio = dist > 0 ? Math.min(1, 15 / dist) : 1
await page.mouse.move(fromX + dx * activationRatio, fromY + dy * activationRatio)
await page.waitForTimeout(50)
// Move in several chunks so the intermediate dragmove handlers run
const chunks = 8
for (let i = 1; i <= chunks; i++) {
const x = fromX + (dx * i) / chunks
const y = fromY + (dy * i) / chunks
await page.mouse.move(x, y)
await page.waitForTimeout(20)
}
// Ensure pointer is directly over target center and allow requestAnimationFrame
// and collision microtasks to settle before triggering drop
await page.mouse.move(toX, toY)
await page.evaluate(
() => new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(resolve))),
)
await page.waitForTimeout(100)
await page.mouse.up()
}
+183
View File
@@ -0,0 +1,183 @@
import type { APIRequestContext, Locator, Page } from '@playwright/test'
interface CreateShareResponse {
id?: string
name?: string
rootFolderId?: string
}
/**
* Locates a file/folder card by its name. Matches both read-only text nodes
* and active EditableText inputs. The returned locator points at the card
* wrapper div (right-clickable to open the card context menu).
*/
export function fileCard(page: Page, name: string): Locator {
return page
.locator('[data-testid="file-card"]')
.filter({
has: page.locator(`input[value="${name}"]`).or(page.getByText(name, { exact: true })),
})
.first()
}
/** Creates a share link through the API for the authenticated request context. */
export async function apiCreateShare(
request: APIRequestContext,
projectId: string,
name: string,
): Promise<{ id: string; name: string; rootFolderId: string }> {
const res = await request.post(`/api/projects/${projectId}/shares`, {
data: { name },
})
if (!res.ok()) {
throw new Error(`Create share API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as CreateShareResponse
if (!body.id || !body.name || !body.rootFolderId) {
throw new Error(`Create share returned an unexpected response: ${JSON.stringify(body)}`)
}
return { id: body.id, name: body.name, rootFolderId: body.rootFolderId }
}
/** Adds assets to a share link through the API. */
export async function apiAddAssetsToShare(
request: APIRequestContext,
shareId: string,
assetIds: string[],
): Promise<void> {
const res = await request.post(`/api/shares/${shareId}/assets`, {
data: { assetIds },
})
if (!res.ok()) {
throw new Error(`Add assets to share API failed (${res.status()}): ${await res.text()}`)
}
}
/** Updates share link settings (e.g. `allowDownload`) through the API. */
export async function apiUpdateShare(
request: APIRequestContext,
shareId: string,
patch: { allowDownload?: boolean },
): Promise<void> {
const res = await request.put(`/api/shares/${shareId}`, { data: patch })
if (!res.ok()) {
throw new Error(`Update share API failed (${res.status()}): ${await res.text()}`)
}
}
/**
* Enables a text watermark on the share link through the API. Uses the same
* default block shape the watermark editor produces (a "CONFIDENTIAL" text
* block), so the transcode workflow runs against a realistic config.
*/
export async function apiEnableShareWatermark(
request: APIRequestContext,
shareId: string,
): Promise<void> {
const res = await request.put(`/api/shares/${shareId}/watermark`, {
data: {
enabled: true,
config: {
blocks: [
{
id: `wm-${Date.now()}`,
type: 'text',
text: 'CONFIDENTIAL',
x: 0.5,
y: 0.5,
// size is a fraction (0..1) of the canvas width
size: 0.05,
color: '#999999',
opacity: 0.5,
rotation: -30,
},
],
},
},
})
if (!res.ok()) {
throw new Error(`Enable share watermark API failed (${res.status()}): ${await res.text()}`)
}
}
/** Requests a public download URL. Returns status + body for assertions. */
export async function apiPublicDownloadUrl(
request: APIRequestContext,
shareId: string,
fileId: string,
key: string,
): Promise<{ status: number; body: unknown }> {
const res = await request.post(`/api/shares/${shareId}/files/${fileId}/download-url`, {
data: { key },
})
return { status: res.status(), body: await res.json().catch(() => null) }
}
/** Uploads a file asset through the official API upload task endpoints. */
export async function apiUploadFile(
request: APIRequestContext,
teamId: string,
parentId: string,
fileName: string,
mimeType: string,
buffer: Buffer,
): Promise<{ fileId: string; fileName: string }> {
const tempId = `temp-${Date.now()}`
const createRes = await request.post(`/api/teams/${teamId}/upload/tasks`, {
data: {
parentId,
files: [
{
id: tempId,
name: fileName,
type: 'file',
size: buffer.length,
mediaType: mimeType,
children: [],
},
],
},
})
if (!createRes.ok()) {
throw new Error(`Create upload task failed (${createRes.status()}): ${await createRes.text()}`)
}
const taskData = (await createRes.json()) as {
taskId: string
presignedUrls: Array<{ id: string; fileId: string; url: string }>
createdAssets?: Array<{ tempId: string; assetId: string }>
}
const presigned = taskData.presignedUrls.find((p) => p.id === tempId)
const createdAssetId =
taskData.createdAssets?.find((c) => c.tempId === tempId)?.assetId || presigned?.fileId
if (!presigned || !createdAssetId) {
throw new Error('Create upload task did not return presigned URL or asset ID')
}
// Upload file buffer to presigned URL
const uploadRes = await request.put(presigned.url, {
headers: {
'Content-Type': mimeType,
},
data: buffer,
})
if (!uploadRes.ok()) {
throw new Error(
`Upload to S3 presigned URL failed (${uploadRes.status()}): ${await uploadRes.text()}`,
)
}
// Confirm upload task
const confirmRes = await request.patch(`/api/teams/${teamId}/upload/tasks/${taskData.taskId}`, {
data: {
fileId: createdAssetId,
status: 'success',
},
})
if (!confirmRes.ok()) {
throw new Error(
`Confirm upload task failed (${confirmRes.status()}): ${await confirmRes.text()}`,
)
}
return { fileId: createdAssetId, fileName }
}
+29
View File
@@ -0,0 +1,29 @@
import type { APIRequestContext } from '@playwright/test'
export function uniqueProjectName(): string {
return `Project ${Date.now()}-${Math.random().toString(36).slice(2, 6)}`
}
interface CreateProjectResponse {
id?: string
name?: string
}
/** Creates a project through the API for the authenticated request context. */
export async function apiCreateProject(
request: APIRequestContext,
teamId: string,
name: string,
): Promise<{ id: string; name: string }> {
const res = await request.post(`/api/teams/${teamId}/projects`, {
data: { name },
})
if (!res.ok()) {
throw new Error(`Create project API failed (${res.status()}): ${await res.text()}`)
}
const body = (await res.json()) as CreateProjectResponse
if (!body.id || !body.name) {
throw new Error(`Create project returned an unexpected response: ${JSON.stringify(body)}`)
}
return { id: body.id, name: body.name }
}
+121
View File
@@ -0,0 +1,121 @@
import type { Browser, BrowserContext } from '@playwright/test'
import type { PrismaClient } from '../../../../packages/db/src/generated/prisma/client'
import { E2E_APP_URL, E2E_PASSWORD, apiSignup, injectAuthState, uniqueEmail } from './auth'
export interface SeededMember {
userId: string
email: string
teamMemberId: string
context?: BrowserContext
}
/**
* Seeds a new user with a team membership of the given role.
* If `browser` and `ownerContext` are provided, generates an invite code via the owner's request context
* so `apiSignup` succeeds and session cookies/auth state are initialized.
*/
export async function seedTeamMember(
prisma: PrismaClient,
teamId: string,
role: 'owner' | 'editor' | 'reviewer',
browser?: Browser,
ownerContext?: BrowserContext,
): Promise<SeededMember> {
if (browser && ownerContext) {
const inviteRes = await ownerContext.request.post(`/api/teams/${teamId}/invite`, {
data: { role: role === 'owner' ? 'editor' : role },
})
if (!inviteRes.ok()) {
throw new Error(`Failed to generate team invite code: ${await inviteRes.text()}`)
}
const inviteBody = (await inviteRes.json()) as { code: string }
// eslint-disable-next-line @typescript-eslint/naming-convention
const context = await browser.newContext({ baseURL: E2E_APP_URL })
const email = uniqueEmail(`member-${role}`)
const user = await apiSignup(context.request, email, E2E_PASSWORD, {
inviteCode: inviteBody.code,
})
await injectAuthState(context, user)
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user.id } },
})
if (tm && tm.role !== role) {
await prisma.teamMember.update({
where: { id: tm.id },
data: { role, scope: 'team' },
})
}
return { userId: user.id, email, teamMemberId: tm!.id, context }
}
const email = uniqueEmail(`member-${role}`)
const user = await prisma.user.create({
data: { name: email, email, password: 'Password123!' },
})
const tm = await prisma.teamMember.create({
data: { teamId, userId: user.id, role, scope: 'team' },
})
return { userId: user.id, email, teamMemberId: tm.id }
}
/**
* Seeds a new user with a project membership of the given role.
* If `browser` and `ownerContext` are provided, generates an invite code via the owner's request context
* so `apiSignup` succeeds and session cookies/auth state are initialized.
*/
export async function seedProjectMember(
prisma: PrismaClient,
teamId: string,
projectId: string,
role: 'editor' | 'reviewer',
scope: 'team' | 'project' = 'project',
browser?: Browser,
ownerContext?: BrowserContext,
): Promise<SeededMember & { projectMemberId: string }> {
if (browser && ownerContext) {
const inviteRes = await ownerContext.request.post(`/api/projects/${projectId}/invite`, {
data: { role },
})
if (!inviteRes.ok()) {
throw new Error(`Failed to generate project invite code: ${await inviteRes.text()}`)
}
const inviteBody = (await inviteRes.json()) as { code: string }
// eslint-disable-next-line @typescript-eslint/naming-convention
const context = await browser.newContext({ baseURL: E2E_APP_URL })
const email = uniqueEmail(`proj-member-${role}`)
const user = await apiSignup(context.request, email, E2E_PASSWORD, {
inviteCode: inviteBody.code,
})
await injectAuthState(context, user)
const tm = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user.id } },
})
const pm = await prisma.projectMember.findFirst({
where: { projectId, teamMemberId: tm!.id },
})
if (pm && pm.role !== role) {
await prisma.projectMember.update({
where: { id: pm.id },
data: { role },
})
}
return { userId: user.id, email, teamMemberId: tm!.id, projectMemberId: pm!.id, context }
}
const email = uniqueEmail(`proj-member-${role}`)
const user = await prisma.user.create({
data: { name: email, email, password: 'Password123!' },
})
const tm = await prisma.teamMember.create({
data: { teamId, userId: user.id, role: scope === 'team' ? 'editor' : 'reviewer', scope },
})
const pm = await prisma.projectMember.create({
data: { projectId, teamMemberId: tm.id, role },
})
return { userId: user.id, email, teamMemberId: tm.id, projectMemberId: pm.id }
}
+55
View File
@@ -0,0 +1,55 @@
import { expect, type Locator, type Page } from '@playwright/test'
export function parseTeamIdFromUrl(url: string): string {
const match = url.match(/\/teams\/([^/]+)/)
if (!match) throw new Error(`Could not parse teamId from URL: ${url}`)
return match[1]
}
/** Performs the signup UI flow and waits for the redirect to the team page. */
export async function signupViaUi(page: Page, email: string, password: string): Promise<string> {
await page.goto('/signup')
await page.fill('#email', email)
await page.fill('#password', password)
await page.click('button[type="submit"]')
await page.waitForURL(/\/teams\/[^/]+/)
return parseTeamIdFromUrl(page.url())
}
/** Performs the login UI flow and waits for the redirect to the team page. */
export async function loginViaUi(page: Page, email: string, password: string): Promise<string> {
await page.goto('/login')
await page.fill('#email', email)
await page.fill('#password', password)
await page.click('button[type="submit"]')
await page.waitForURL(/\/teams\/[^/]+/)
return parseTeamIdFromUrl(page.url())
}
/** Opens the team members dialog from the team page header. */
export async function openMembersDialog(page: Page): Promise<Locator> {
await page.getByTestId('team-members-trigger').click()
const dialog = page.locator('[role="dialog"]')
await expect(dialog).toBeVisible()
return dialog
}
/** Opens the project members dialog from the project file-browser toolbar. */
export async function openProjectMembersDialog(page: Page): Promise<Locator> {
await page.getByTestId('project-members-trigger').click()
const dialog = page.locator('[role="dialog"]')
await expect(dialog).toBeVisible()
return dialog
}
/** Clicks "Generate Link" in the members dialog and returns the invite link. */
export async function generateInviteLink(dialog: Locator): Promise<string> {
await dialog.getByRole('button', { name: 'Generate Link' }).click()
const inviteInput = dialog.locator('input[readonly]')
await expect(inviteInput).toBeVisible()
const inviteLink = await inviteInput.inputValue()
if (!inviteLink.includes('inviteCode=')) {
throw new Error(`Unexpected invite link: ${inviteLink}`)
}
return inviteLink
}
+38
View File
@@ -0,0 +1,38 @@
import { globalTestSetup } from '../../../packages/db/src/test-global-setup'
import { randomBytes } from 'crypto'
import * as fs from 'fs'
import * as path from 'path'
import { fileURLToPath } from 'url'
const currentDir = path.dirname(fileURLToPath(import.meta.url))
async function start() {
console.log('Starting E2E test database container...')
await globalTestSetup()
// Generate a random S3 bucket name
const randomSuffix = randomBytes(4).toString('hex')
const bucketName = `shumai-e2e-${randomSuffix}`
process.env.S3_BUCKET = bucketName
process.env.SHUMAI_SERVER_PORT = '5200'
process.env.BETTER_AUTH_URL = 'http://localhost:5200'
process.env.NODE_ENV = 'development'
process.env.SHUMAI_E2E = 'true'
// Write variables to .env.e2e file so the teardown can load them
const envContent = [`DATABASE_URL=${process.env.DATABASE_URL}`, `S3_BUCKET=${bucketName}`].join(
'\n',
)
fs.writeFileSync(path.resolve(currentDir, '.env.e2e'), envContent)
console.log(`E2E env file written. Starting Web App...`)
// Now run the web app
await import('../src/index.ts')
}
start().catch((err) => {
console.error('Failed to start E2E server:', err)
process.exit(1)
})
+18
View File
@@ -0,0 +1,18 @@
import { expect, test } from '../../fixtures'
import { apiSignup, E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { loginViaUi } from '../../helpers/ui'
test('should log in with existing credentials', async ({ page, request }) => {
const email = uniqueEmail('login')
const password = E2E_PASSWORD
// Seed an existing user through the API (setup, not the flow under test)
await apiSignup(request, email, password)
// The default page context is a fresh, logged-out session
await loginViaUi(page, email, password)
// The logged-in user lands on their team page
await expect(page).toHaveURL(/\/teams\/[^/]+/)
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
})
@@ -0,0 +1,63 @@
import { expect, test } from '../../fixtures'
import { apiSignup, E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { loginViaUi } from '../../helpers/ui'
test('should show error when accessing reset-password page without token', async ({ page }) => {
await page.goto('/reset-password')
await expect(page.getByText('Invalid or missing reset token.')).toBeVisible()
await expect(page.getByRole('button', { name: 'Go to Login' })).toBeVisible()
})
test('should reset password with valid token and allow logging in with new password', async ({
page,
request,
prisma,
}) => {
const email = uniqueEmail('reset-pw')
const oldPassword = E2E_PASSWORD
const newPassword = 'newSecretPassword123'
// 1. Seed user
await apiSignup(request, email, oldPassword)
// 2. Request password reset via API
const resetRes = await request.post('/api/auth/request-password-reset', {
data: {
email,
redirectTo: '/reset-password',
},
})
expect(resetRes.ok()).toBe(true)
// Retrieve the generated verification token from DB
const verification = await prisma.verification.findFirst({
where: {
identifier: { startsWith: 'reset-password:' },
},
orderBy: { createdAt: 'desc' },
})
expect(verification).not.toBeNull()
const token = verification!.identifier.replace('reset-password:', '')
// 3. Open reset password page with token
await page.goto(`/reset-password?token=${token}`)
// 4. Fill in new password and confirmation
await page.locator('input#password').fill(newPassword)
await page.locator('input#confirmPassword').fill(newPassword)
// 5. Submit form
await page.getByRole('button', { name: 'Reset Password' }).click()
// 6. Verify success state
await expect(page.getByText('Password reset successfully!')).toBeVisible()
// 7. Click Go to Login
await page.getByRole('button', { name: 'Go to Login' }).click()
await expect(page).toHaveURL('/login')
// 8. Log in with the new password
await loginViaUi(page, email, newPassword)
await expect(page).toHaveURL(/\/teams\/[^/]+/)
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
})
+24
View File
@@ -0,0 +1,24 @@
import { expect, test } from '../../fixtures'
import { E2E_PASSWORD, uniqueEmail } from '../../helpers/auth'
import { signupViaUi } from '../../helpers/ui'
test('should sign up as the first user and become the team owner', async ({ page, prisma }) => {
const email = uniqueEmail('signup')
const password = E2E_PASSWORD
const teamId = await signupViaUi(page, email, password)
// The first user is redirected to their single team
await expect(page).toHaveURL(/\/teams\/[^/]+/)
await expect(page.getByRole('heading', { name: 'Projects' })).toBeVisible()
// The new user exists and is the owner of the team
const user = await prisma.user.findUnique({ where: { email } })
expect(user).not.toBeNull()
const membership = await prisma.teamMember.findUnique({
where: { teamIdUserId: { teamId, userId: user!.id } },
})
expect(membership?.role).toBe('owner')
expect(membership?.scope).toBe('team')
})
@@ -0,0 +1,68 @@
import { expect, test } from '../../fixtures'
test.use({ fileOptions: { mediaType: 'audio' } })
test('upload an audio file, create a comment at a non-zero timestamp', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Audio timestamp comment ${Date.now()}`
// Wait for audio transcode completion
await expect
.poll(
async () => {
const asset = await prisma.asset.findUnique({ where: { id: fileId } })
return asset?.status
},
{ timeout: 30_000 },
)
.toBe('processed')
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Wait for audio/video media element to be visible
const mediaEl = page.locator('audio, video').first()
await expect(mediaEl).toBeVisible({ timeout: 30_000 })
// Seek media element to non-zero timestamp (e.g. 1 second)
await page.evaluate(() => {
const el = document.querySelector('audio, video') as HTMLMediaElement | null
if (el) el.currentTime = 1
})
await page.waitForTimeout(500)
// Type comment text and send
const input = page.locator('[contenteditable="true"]').first()
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Ensure comment is persisted in DB before page reload
await expect
.poll(async () => {
return prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
})
.not.toBeNull()
// Reload page
await page.reload()
// Click the comment in right sidebar
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// Verify media element jumped to timestamp
await expect
.poll(async () => {
return page.evaluate(() => {
const el = document.querySelector('audio, video') as HTMLMediaElement | null
return el ? el.currentTime : 0
})
})
.toBeGreaterThan(0)
})
@@ -0,0 +1,32 @@
import { expect, test } from '../../fixtures'
test('create a comment on a binary file', async ({ file, prisma }) => {
const { page, projectId, fileId } = file
const commentText = `Binary comment ${Date.now()}`
await page.goto(`/projects/${projectId}/files/${fileId}`)
// Wait for file page & comments sidebar to load
const input = page.locator('[contenteditable="true"]').first()
await expect(input).toBeVisible()
// Type comment text and send
await input.fill(commentText)
const sendBtn = page.locator('button:has(svg.lucide-arrow-up)').last()
await sendBtn.click()
// Verify comment card appears in sidebar
await expect(page.getByText(commentText)).toBeVisible()
// Refresh page and click the comment
await page.reload()
const commentCard = page.getByText(commentText).first()
await expect(commentCard).toBeVisible()
await commentCard.click()
// DB verification
const commentInDb = await prisma.assetComment.findFirst({
where: { assetId: fileId, message: commentText },
})
expect(commentInDb).not.toBeNull()
})

Some files were not shown because too many files have changed in this diff Show More