feat: plugin-sdk safety all around (#29323)

mobile/lib/domain/services/asset.service.dart

@@ -1,6 +1,5 @@
 import 'package:immich_mobile/domain/models/album/local_album.model.dart';
 import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/domain/models/asset_edit.model.dart';
 import 'package:immich_mobile/domain/models/exif.model.dart';
 import 'package:immich_mobile/infrastructure/repositories/local_asset.repository.dart';
 import 'package:immich_mobile/infrastructure/repositories/remote_asset.repository.dart';
@@ -78,12 +77,4 @@ class AssetService {
     await _apiRepository.updateFavorite(remoteIds, isFavorite);
     await _remoteRepository.updateFavorite(remoteIds, isFavorite);
   }
-
-  Future<void> applyEdits(String remoteId, List<AssetEdit> edits) async {
-    if (edits.isEmpty) {
-      await _apiRepository.removeEdits(remoteId);
-    } else {
-      await _apiRepository.editAsset(remoteId, edits);
-    }
-  }
 }

mobile/lib/presentation/actions/edit.action.dart

@@ -1,70 +0,0 @@
-import 'dart:async';
-
-import 'package:auto_route/auto_route.dart';
-import 'package:flutter/material.dart';
-import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/domain/models/asset_edit.model.dart';
-import 'package:immich_mobile/generated/translations.g.dart';
-import 'package:immich_mobile/presentation/actions/action.dart';
-import 'package:immich_mobile/presentation/pages/edit/editor.provider.dart';
-import 'package:immich_mobile/presentation/widgets/images/image_provider.dart';
-import 'package:immich_mobile/providers/infrastructure/asset.provider.dart';
-import 'package:immich_mobile/providers/server_info.provider.dart';
-import 'package:immich_mobile/providers/websocket.provider.dart';
-import 'package:immich_mobile/routing/router.dart';
-import 'package:immich_mobile/utils/semver.dart';
-
-class EditAssetAction extends AssetAction<RemoteAsset> {
-  const EditAssetAction({required super.assets});
-
-  @override
-  IconData get icon => Icons.tune;
-
-  @override
-  String label(ActionScope scope) => scope.context.t.edit;
-
-  @override
-  Iterable<RemoteAsset> filter(ActionScope scope) =>
-      assets.where((asset) => asset is RemoteAsset && asset.ownerId == scope.authUser.id && asset.isEditable).cast();
-
-  @override
-  bool isVisible(ActionScope scope) =>
-      filter(scope).length == 1 &&
-      scope.ref.watch(serverInfoProvider).serverVersion >= const SemVer(major: 2, minor: 6, patch: 0);
-
-  @override
-  Future<void> onAction(ActionScope scope) async {
-    final ActionScope(:context, :ref) = scope;
-
-    final asset = filter(scope).first;
-    final remoteId = asset.id;
-    final repository = ref.read(remoteAssetRepositoryProvider);
-    final (edits, exif) = await (repository.getAssetEdits(remoteId), repository.getExif(remoteId)).wait;
-    if (exif == null || !context.mounted) {
-      return;
-    }
-
-    ref.read(editorStateProvider.notifier).init(edits, exif);
-    unawaited(
-      context.pushRoute(
-        DriftEditImageRoute(
-          image: Image(image: getFullImageProvider(asset, edited: false)),
-          applyEdits: (newEdits) => applyEdits(ref, remoteId, newEdits),
-        ),
-      ),
-    );
-  }
-
-  @visibleForTesting
-  static Future<void> applyEdits(WidgetRef ref, String remoteId, List<AssetEdit> edits) async {
-    final websocket = ref.read(websocketProvider.notifier);
-
-    bool isCurrentId(dynamic data) => data is Map && (data['asset'] as Map?)?['id'] == remoteId;
-    await ref.read(assetServiceProvider).applyEdits(remoteId, edits);
-    await Future.any([
-      websocket.waitForEvent('AssetEditReadyV1', isCurrentId, const Duration(seconds: 10)),
-      websocket.waitForEvent('AssetEditReadyV2', isCurrentId, const Duration(seconds: 10)),
-    ]).catchError((_) {});
-  }
-}

mobile/lib/presentation/actions/favorite.action.dart

@@ -21,7 +21,7 @@ class FavoriteAction extends AssetAction<RemoteAsset> {
       .where(
         (asset) => asset is RemoteAsset && asset.ownerId == scope.authUser.id && asset.isFavorite == !shouldFavorite,
       )
-      .cast();
+      .cast<RemoteAsset>();
 
   @override
   bool isVisible(ActionScope scope) => filter(scope).isNotEmpty;

mobile/lib/presentation/widgets/action_buttons/edit_image_action_button.widget.dart

@@ -0,0 +1,59 @@
+import 'dart:async';
+
+import 'package:auto_route/auto_route.dart';
+import 'package:flutter/material.dart';
+import 'package:hooks_riverpod/hooks_riverpod.dart';
+import 'package:immich_mobile/constants/enums.dart';
+import 'package:immich_mobile/domain/models/asset_edit.model.dart';
+import 'package:immich_mobile/extensions/translate_extensions.dart';
+import 'package:immich_mobile/presentation/pages/edit/editor.provider.dart';
+import 'package:immich_mobile/presentation/widgets/action_buttons/base_action_button.widget.dart';
+import 'package:immich_mobile/presentation/widgets/images/image_provider.dart';
+import 'package:immich_mobile/providers/asset_viewer/asset_viewer.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/action.provider.dart';
+import 'package:immich_mobile/providers/infrastructure/asset.provider.dart';
+import 'package:immich_mobile/routing/router.dart';
+
+class EditImageActionButton extends ConsumerWidget {
+  const EditImageActionButton({super.key});
+
+  @override
+  Widget build(BuildContext context, WidgetRef ref) {
+    final currentAsset = ref.watch(assetViewerProvider.select((s) => s.currentAsset));
+
+    Future<void> editImage(List<AssetEdit> edits) async {
+      if (currentAsset == null || currentAsset.remoteId == null) {
+        return;
+      }
+
+      await ref.read(actionProvider.notifier).applyEdits(ActionSource.viewer, edits);
+    }
+
+    Future<void> onPress() async {
+      if (currentAsset == null || currentAsset.remoteId == null) {
+        return;
+      }
+
+      final imageProvider = getFullImageProvider(currentAsset, edited: false);
+
+      final image = Image(image: imageProvider);
+      final (edits, exifInfo) = await (
+        ref.read(remoteAssetRepositoryProvider).getAssetEdits(currentAsset.remoteId!),
+        ref.read(remoteAssetRepositoryProvider).getExif(currentAsset.remoteId!),
+      ).wait;
+
+      if (exifInfo == null) {
+        return;
+      }
+
+      ref.read(editorStateProvider.notifier).init(edits, exifInfo);
+      await context.pushRoute(DriftEditImageRoute(image: image, applyEdits: editImage));
+    }
+
+    return BaseActionButton(
+      iconData: Icons.tune,
+      label: "edit".t(context: context),
+      onPressed: onPress,
+    );
+  }
+}

mobile/lib/presentation/widgets/asset_viewer/bottom_bar.widget.dart

@@ -4,12 +4,11 @@ import 'package:immich_mobile/constants/enums.dart';
 import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
 import 'package:immich_mobile/domain/services/timeline.service.dart';
 import 'package:immich_mobile/extensions/build_context_extensions.dart';
-import 'package:immich_mobile/presentation/actions/action.widget.dart';
-import 'package:immich_mobile/presentation/actions/edit.action.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/add_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/delete_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/delete_local_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/delete_permanent_action_button.widget.dart';
+import 'package:immich_mobile/presentation/widgets/action_buttons/edit_image_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/restore_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/share_action_button.widget.dart';
 import 'package:immich_mobile/presentation/widgets/action_buttons/upload_action_button.widget.dart';
@@ -20,8 +19,8 @@ import 'package:immich_mobile/providers/infrastructure/timeline.provider.dart';
 import 'package:immich_mobile/providers/routes.provider.dart';
 import 'package:immich_mobile/providers/server_info.provider.dart';
 import 'package:immich_mobile/providers/user.provider.dart';
+import 'package:immich_mobile/utils/semver.dart';
 import 'package:immich_mobile/widgets/asset_viewer/video_controls.dart';
-import 'package:immich_ui/immich_ui.dart';
 
 class ViewerBottomBar extends ConsumerWidget {
   const ViewerBottomBar({super.key});
@@ -42,7 +41,6 @@ class ViewerBottomBar extends ConsumerWidget {
     final isInTrash = ref.read(timelineServiceProvider).origin == TimelineOrigin.trash;
 
     final originalTheme = context.themeData;
-    final actionAsset = [asset];
 
     final actions = <Widget>[
       if (isInTrash && isOwner && asset.hasRemote)
@@ -53,7 +51,9 @@ class ViewerBottomBar extends ConsumerWidget {
       if (!isInLockedView) ...[
         if (!isInTrash) ...[
           if (asset.isLocalOnly) const UploadActionButton(source: ActionSource.viewer),
-          ActionColumnButtonWidget(action: EditAssetAction(assets: actionAsset)),
+          // edit sync was added in 2.6.0
+          if (asset.isEditable && serverInfo.serverVersion >= const SemVer(major: 2, minor: 6, patch: 0))
+            const EditImageActionButton(),
           if (asset.hasRemote) AddActionButton(originalTheme: originalTheme),
         ],
         if (isOwner) ...[
@@ -104,10 +104,7 @@ class ViewerBottomBar extends ConsumerWidget {
                           OcrToggleButton(asset: asset),
                           if (asset.isVideo) VideoControls(videoPlayerName: asset.heroTag),
                           if (!isReadonlyModeEnabled)
-                            ImmichColorOverride(
-                              color: Colors.white,
-                              child: Row(mainAxisAlignment: MainAxisAlignment.spaceEvenly, children: actions),
-                            ),
+                            Row(mainAxisAlignment: MainAxisAlignment.spaceEvenly, children: actions),
                         ],
                       ),
                     ),

mobile/lib/providers/infrastructure/action.provider.dart

@@ -135,6 +135,16 @@ class ActionNotifier extends Notifier<void> {
     };
   }
 
+  Future<ActionResult> troubleshoot(ActionSource source, BuildContext context) async {
+    final assets = _getAssets(source);
+    if (assets.length > 1) {
+      return ActionResult(count: assets.length, success: false, error: 'Cannot troubleshoot multiple assets');
+    }
+    unawaited(context.pushRoute(AssetTroubleshootRoute(asset: assets.first)));
+
+    return ActionResult(count: assets.length, success: true);
+  }
+
   Future<ActionResult> shareLink(ActionSource source, BuildContext context) async {
     final ids = _getRemoteIdsForSource(source);
     try {
@@ -621,6 +631,37 @@ class ActionNotifier extends Notifier<void> {
       });
     }
   }
+
+  Future<ActionResult> applyEdits(ActionSource source, List<AssetEdit> edits) async {
+    final ids = _getOwnedRemoteIdsForSource(source);
+
+    if (ids.length != 1) {
+      _logger.warning('applyEdits called with multiple assets, expected single asset');
+      return ActionResult(count: ids.length, success: false, error: 'Expected single asset for applying edits');
+    }
+
+    Future<void> editReady;
+    if (ref.read(serverInfoProvider).serverVersion >= const SemVer(major: 3, minor: 0, patch: 0)) {
+      editReady = ref.read(websocketProvider.notifier).waitForEvent("AssetEditReadyV2", (dynamic data) {
+        final eventAsset = SyncAssetV2.fromJson(data["asset"]);
+        return eventAsset?.id == ids.first;
+      }, const Duration(seconds: 10));
+    } else {
+      editReady = ref.read(websocketProvider.notifier).waitForEvent("AssetEditReadyV1", (dynamic data) {
+        final eventAsset = SyncAssetV1.fromJson(data["asset"]);
+        return eventAsset?.id == ids.first;
+      }, const Duration(seconds: 10));
+    }
+
+    try {
+      await _service.applyEdits(ids.first, edits);
+      await editReady;
+      return const ActionResult(count: 1, success: true);
+    } catch (error, stack) {
+      _logger.severe('Failed to apply edits to assets', error, stack);
+      return ActionResult(count: ids.length, success: false, error: error.toString());
+    }
+  }
 }
 
 extension on Iterable<RemoteAsset> {

mobile/lib/services/action.service.dart

@@ -305,6 +305,14 @@ class ActionService {
     return true;
   }
 
+  Future<void> applyEdits(String remoteId, List<AssetEdit> edits) async {
+    if (edits.isEmpty) {
+      await _assetApiRepository.removeEdits(remoteId);
+    } else {
+      await _assetApiRepository.editAsset(remoteId, edits);
+    }
+  }
+
   Future<int> _deleteLocalAssets(List<String> localIds) async {
     final deletedIds = await _assetMediaRepository.deleteAll(localIds);
     if (deletedIds.isEmpty) {

mobile/test/domain/service.mock.dart

@@ -5,7 +5,6 @@ import 'package:immich_mobile/domain/services/user.service.dart';
 import 'package:immich_mobile/domain/utils/background_sync.dart';
 import 'package:immich_mobile/platform/native_sync_api.g.dart';
 import 'package:immich_mobile/services/app_settings.service.dart';
-import 'package:immich_mobile/services/server_info.service.dart';
 import 'package:mocktail/mocktail.dart';
 
 class MockStoreService extends Mock implements StoreService {}
@@ -21,5 +20,3 @@ class MockPartnerService extends Mock implements PartnerService {}
 class MockAssetService extends Mock implements AssetService {}
 
 class MockUserService extends Mock implements UserService {}
-
-class MockServerInfoService extends Mock implements ServerInfoService {}

mobile/test/unit/factories/remote_asset_factory.dart

@@ -5,13 +5,7 @@ import '../../utils.dart';
 class RemoteAssetFactory {
   const RemoteAssetFactory();
 
-  static RemoteAsset create({
-    String? id,
-    String? name,
-    String? ownerId,
-    bool isFavorite = false,
-    AssetType type = .image,
-  }) {
+  static RemoteAsset create({String? id, String? name, String? ownerId, bool isFavorite = false}) {
     id = TestUtils.uuid(id);
 
     return RemoteAsset(
@@ -19,7 +13,7 @@ class RemoteAssetFactory {
       name: name ?? 'remote_$id.jpg',
       ownerId: TestUtils.uuid(ownerId),
       checksum: 'checksum-$id',
-      type: type,
+      type: .image,
       createdAt: TestUtils.yesterday(),
       updatedAt: TestUtils.now(),
       isFavorite: isFavorite,

mobile/test/unit/mocks.dart

@@ -1,7 +1,6 @@
 import 'dart:typed_data';
 
 import 'package:immich_mobile/constants/enums.dart';
-import 'package:immich_mobile/domain/models/asset_edit.model.dart';
 import 'package:immich_mobile/domain/models/user.model.dart';
 import 'package:mocktail/mocktail.dart' as mock;
 import 'package:mocktail/mocktail.dart';
@@ -16,7 +15,6 @@ class RepositoryMocks {
   final localAlbum = MockLocalAlbumRepository();
   final localAsset = MockDriftLocalAssetRepository();
   final trashedAsset = MockTrashedLocalAssetRepository();
-  final remoteAsset = MockRemoteAssetRepository();
 
   final nativeApi = MockNativeSyncApi();
 
@@ -30,13 +28,12 @@ class RepositoryMocks {
     reset(localAsset);
     reset(trashedAsset);
     reset(nativeApi);
-    reset(remoteAsset);
   }
 }
 
 class ServiceMocks {
-  final partner = PartnerStub(MockPartnerService());
-  final user = UserStub(MockUserService());
+  final PartnerStub partner = PartnerStub(MockPartnerService());
+  final UserStub user = UserStub(MockUserService());
   final asset = AssetStub(MockAssetService());
 
   ServiceMocks() {
@@ -72,7 +69,6 @@ class ServiceMocks {
 
   void _stubAssetService() {
     when(asset.updateFavorite).thenAnswer((_) async {});
-    when(asset.applyEdits).thenAnswer((_) async {});
   }
 }
 
@@ -80,11 +76,10 @@ void _registerFallbacks() {
   registerFallbackValue(LocalAlbumFactory.create());
   registerFallbackValue(LocalAssetFactory.create());
   registerFallbackValue(Uint8List(0));
-  registerFallbackValue(<AssetEdit>[]);
 }
 
-extension type const Stub<T extends Mock>(T mockedClass) {
-  void reset() => mock.reset(mockedClass);
+extension type const Stub<T extends Mock>(T mockedService) {
+  void reset() => mock.reset(mockedService);
 }
 
 extension type const PartnerStub(MockPartnerService service) implements Stub<MockPartnerService> {
@@ -135,7 +130,4 @@ extension type const UserStub(MockUserService service) implements Stub<MockUserS
 extension type const AssetStub(MockAssetService service) implements Stub<MockAssetService> {
   Future<void> Function() get updateFavorite =>
       () => service.updateFavorite(any(), any());
-
-  Future<void> Function() get applyEdits =>
-      () => service.applyEdits(any(), any());
 }

mobile/test/unit/presentation/actions/edit_action_test.dart

@@ -1,119 +0,0 @@
-import 'package:flutter/material.dart';
-import 'package:flutter_test/flutter_test.dart';
-import 'package:hooks_riverpod/hooks_riverpod.dart';
-import 'package:immich_mobile/domain/models/asset/base_asset.model.dart';
-import 'package:immich_mobile/domain/models/asset_edit.model.dart';
-import 'package:immich_mobile/models/server_info/server_version.model.dart';
-import 'package:immich_mobile/presentation/actions/action.widget.dart';
-import 'package:immich_mobile/presentation/actions/edit.action.dart';
-import 'package:immich_mobile/providers/infrastructure/asset.provider.dart';
-import 'package:immich_mobile/providers/server_info.provider.dart';
-import 'package:immich_mobile/providers/websocket.provider.dart';
-import 'package:immich_ui/immich_ui.dart';
-import 'package:mocktail/mocktail.dart';
-
-import '../../../infrastructure/repository.mock.dart';
-import '../../factories/remote_asset_factory.dart';
-import '../../presentation_context.dart';
-import '../../riverpod_mocks.dart';
-
-void main() {
-  late PresentationContext context;
-
-  const supportedVersion = ServerVersion(major: 2, minor: 6, patch: 0);
-  const unsupportedVersion = ServerVersion(major: 2, minor: 5, patch: 9);
-
-  setUp(() async {
-    context = await PresentationContext.create();
-  });
-
-  tearDown(() {
-    context.dispose();
-  });
-
-  List<Override> overrides(ServerVersion version) => [
-    ...context.overrides,
-    serverInfoProvider.overrideWith((ref) => FakeServerInfoNotifier(version)),
-  ];
-
-  RemoteAsset owned({AssetType type = AssetType.image}) =>
-      RemoteAssetFactory.create(ownerId: context.currentUser.id, type: type);
-
-  Future<void> pumpAction(WidgetTester tester, EditAssetAction action, {ServerVersion version = supportedVersion}) =>
-      tester.pumpTestWidget(ActionIconButtonWidget(action: action), overrides: overrides(version));
-
-  group('EditAssetAction', () {
-    testWidgets('visible for a single owned editable asset on a supported server', (tester) async {
-      await pumpAction(tester, EditAssetAction(assets: [owned()]));
-
-      expect(find.byType(ImmichIconButton), findsOneWidget);
-    });
-
-    testWidgets('hidden when the server is older than 2.6.0', (tester) async {
-      await pumpAction(tester, EditAssetAction(assets: [owned()]), version: unsupportedVersion);
-
-      expect(find.byType(ImmichIconButton), findsNothing);
-    });
-
-    testWidgets('hidden for more than one asset', (tester) async {
-      await pumpAction(tester, EditAssetAction(assets: [owned(), owned()]));
-
-      expect(find.byType(ImmichIconButton), findsNothing);
-    });
-
-    testWidgets('hidden for an asset owned by someone else', (tester) async {
-      await pumpAction(tester, EditAssetAction(assets: [RemoteAssetFactory.create()]));
-
-      expect(find.byType(ImmichIconButton), findsNothing);
-    });
-
-    testWidgets('hidden for a non-editable asset', (tester) async {
-      await pumpAction(tester, EditAssetAction(assets: [owned(type: AssetType.video)]));
-
-      expect(find.byType(ImmichIconButton), findsNothing);
-    });
-  });
-
-  group('EditAssetAction onAction', () {
-    testWidgets('reads the edits and exif for the asset from the repository', (tester) async {
-      final asset = owned();
-      final repository = MockRemoteAssetRepository();
-      when(() => repository.getAssetEdits(any())).thenAnswer((_) async => const <AssetEdit>[]);
-      when(() => repository.getExif(any())).thenAnswer((_) async => null);
-
-      await tester.pumpTestAction(
-        EditAssetAction(assets: [asset]),
-        overrides: [...overrides(supportedVersion), remoteAssetRepositoryProvider.overrideWithValue(repository)],
-      );
-      await tester.pumpAndSettle();
-
-      verify(() => repository.getAssetEdits(asset.id)).called(1);
-      verify(() => repository.getExif(asset.id)).called(1);
-    });
-
-    testWidgets('applyEdits forwards the edits to the service and waits for both ready events', (tester) async {
-      late FakeWebsocketNotifier websocket;
-      const edits = <AssetEdit>[];
-
-      late WidgetRef capturedRef;
-      await tester.pumpTestWidget(
-        Consumer(
-          builder: (_, ref, _) {
-            capturedRef = ref;
-            return const SizedBox.shrink();
-          },
-        ),
-        overrides: [
-          ...context.overrides,
-          assetServiceProvider.overrideWithValue(context.mocks.asset.service),
-          websocketProvider.overrideWith((ref) => websocket = FakeWebsocketNotifier(ref)),
-        ],
-      );
-
-      await EditAssetAction.applyEdits(capturedRef, 'asset-1', edits);
-
-      verify(() => context.mocks.asset.service.applyEdits('asset-1', edits)).called(1);
-      expect(websocket.waitedEvents, containsAll(['AssetEditReadyV1', 'AssetEditReadyV2']));
-    });
-  });
-}

mobile/test/unit/riverpod_mocks.dart

@@ -1,24 +0,0 @@
-import 'package:immich_mobile/models/server_info/server_version.model.dart';
-import 'package:immich_mobile/providers/server_info.provider.dart';
-import 'package:immich_mobile/providers/websocket.provider.dart';
-
-import '../domain/service.mock.dart';
-
-class FakeServerInfoNotifier extends ServerInfoNotifier {
-  FakeServerInfoNotifier([ServerVersion version = const ServerVersion(major: 2, minor: 6, patch: 0)])
-    : super(MockServerInfoService()) {
-    state = state.copyWith(serverVersion: version);
-  }
-}
-
-class FakeWebsocketNotifier extends WebsocketNotifier {
-  FakeWebsocketNotifier(super.ref);
-
-  final List<String> waitedEvents = [];
-
-  @override
-  Future<void> waitForEvent(String event, bool Function(dynamic)? predicate, Duration timeout) {
-    waitedEvents.add(event);
-    return Future.value();
-  }
-}

packages/plugin-core/package.json

@@ -5,8 +5,8 @@
   "main": "src/index.ts",
   "scripts": {
     "build": "pnpm build:tsc && pnpm build:wasm",
-    "build:tsc": "mkdir -p dist && echo \"type Manifest = $(cat manifest.json); \nexport default Manifest;\" > dist/manifest.d.ts && tsc --noEmit && node esbuild.js",
-    "build:wasm": "extism-js dist/index.js -i src/index.d.ts -o dist/plugin.wasm"
+    "build:tsc": "plugin-sdk prepareBuild && tsc --noEmit && node esbuild.js",
+    "build:wasm": "extism-js dist/index.js -i dist/index.d.ts -o dist/plugin.wasm"
   },
   "keywords": [],
   "author": "",

packages/plugin-core/src/index.d.ts

@@ -1,27 +0,0 @@
-// keep in sync with plugin-sdk/host-functions.ts';
-declare module 'extism:host' {
-  interface user {
-    searchAlbums(ptr: PTR): I64;
-    createAlbum(ptr: PTR): I64;
-    addAssetsToAlbum(ptr: PTR): I64;
-    addAssetsToAlbums(ptr: PTR): I64;
-  }
-}
-
-// keep in sync with manifest.json
-declare module 'main' {
-  // filters
-  export function assetFileFilter(): I32;
-  export function assetMissingTimeZoneFilter(): I32;
-  export function assetLocationFilter(): I32;
-  export function assetTypeFilter(): I32;
-
-  // updates
-  export function assetFavorite(): I32;
-  export function assetVisibility(): I32;
-  export function assetArchive(): I32;
-  export function assetLock(): I32;
-  export function assetTimeline(): I32;
-  // export function assetTrash(): I32;
-  export function assetAddToAlbums(): I32;
-}

packages/plugin-core/src/index.ts

@@ -1,175 +1,157 @@
 import { getWrapper } from '@immich/plugin-sdk';
 import { AssetVisibility } from '@immich/sdk';
-import type manifestType from '../dist/manifest';
+import type { Manifest } from '../dist/index.d.ts';
 
-const wrapper = getWrapper<manifestType>();
+const wrapper = getWrapper<Manifest>();
 
-export const assetFileFilter = () => {
-  return wrapper<'assetFileFilter'>(({ data, config }) => {
-    const { pattern, matchType = 'contains', caseSensitive = false } = config;
+export const assetFileFilter = wrapper<'assetFileFilter'>(({ data, config }) => {
+  const { pattern, matchType = 'contains', caseSensitive = false } = config;
 
-    const { asset } = data;
+  const { asset } = data;
 
-    const fileName = asset.originalFileName || '';
-    const searchName = caseSensitive ? fileName : fileName.toLowerCase();
-    const searchPattern = caseSensitive ? pattern : pattern.toLowerCase();
+  const fileName = asset.originalFileName || '';
+  const searchName = caseSensitive ? fileName : fileName.toLowerCase();
+  const searchPattern = caseSensitive ? pattern : pattern.toLowerCase();
 
-    switch (matchType) {
-      case 'contains': {
-        return { workflow: { continue: searchName.includes(searchPattern) } };
-      }
-
-      case 'exact': {
-        return { workflow: { continue: searchName === searchPattern } };
-      }
-
-      case 'startsWith': {
-        return { workflow: { continue: searchName.startsWith(searchPattern) } };
-      }
-
-      case 'regex': {
-        const flags = caseSensitive ? '' : 'i';
-        const regex = new RegExp(searchPattern, flags);
-        return { workflow: { continue: regex.test(fileName) } };
-      }
-
-      default: {
-        return {};
-      }
-    }
-  });
-};
-
-export const assetMissingTimeZoneFilter = () => {
-  return wrapper<'assetMissingTimeZoneFilter'>(({ config, data }) => {
-    const hasTimeZone = !!data.asset?.exifInfo?.timeZone;
-    const needsTimeZone = config.inverse ? true : false;
-    return { workflow: { continue: hasTimeZone === needsTimeZone } };
-  });
-};
-
-export const assetLocationFilter = () => {
-  return wrapper<'assetLocationFilter'>(({ config, data }) => {
-    if (
-      (config.region?.country && config.region.country !== data.asset.exifInfo?.country) ||
-      (config.region?.state && config.region.state !== data.asset.exifInfo?.state) ||
-      (config.region?.city && config.region.city !== data.asset.exifInfo?.city)
-    ) {
-      return { workflow: { continue: false } };
+  switch (matchType) {
+    case 'contains': {
+      return { workflow: { continue: searchName.includes(searchPattern) } };
     }
 
-    const configLat = Number.parseFloat(config.coordinate?.latitude ?? '');
-    const configLon = Number.parseFloat(config.coordinate?.longitude ?? '');
-
-    if (Number.isNaN(configLat) || Number.isNaN(configLat)) {
-      return { workflow: { continue: true } };
+    case 'exact': {
+      return { workflow: { continue: searchName === searchPattern } };
     }
 
-    const assetLat = data.asset.exifInfo?.latitude;
-    const assetLon = data.asset.exifInfo?.longitude;
-
-    if (assetLat === undefined || assetLat === null || assetLon === undefined || assetLon === null) {
-      return { workflow: { continue: false } };
+    case 'startsWith': {
+      return { workflow: { continue: searchName.startsWith(searchPattern) } };
     }
 
-    const earthDiameter = 12742;
-    const deg = Math.PI / 180;
-    const delta = Math.asin(
-      Math.sqrt(
-        Math.pow(Math.sin((assetLat * deg - configLat * deg) / 2), 2) +
-          Math.cos(assetLat * deg) *
-            Math.cos(configLat * deg) *
-            Math.pow(Math.sin((assetLon * deg - configLon * deg) / 2), 2),
-      ),
-    );
-
-    return { workflow: { continue: earthDiameter * delta <= (config.coordinate?.radius ?? 0) } };
-  });
-};
-
-export const assetTypeFilter = () => {
-  return wrapper<'assetTypeFilter'>(({ config, data }) => {
-    return { workflow: { continue: config.allowedTypes.includes(data.asset.type) } };
-  });
-};
-
-export const assetFavorite = () => {
-  return wrapper<'assetFavorite'>(({ config, data }) => {
-    const target = config.inverse ? false : true;
-    if (target !== data.asset.isFavorite) {
-      return {
-        changes: {
-          asset: { isFavorite: target },
-        },
-      };
-    }
-  });
-};
-
-export const assetVisibility = () => {
-  return wrapper<'assetVisibility'>(({ config }) => ({
-    changes: { asset: { visibility: config.visibility as AssetVisibility } },
-  }));
-};
-
-export const assetArchive = () => {
-  return wrapper<'assetArchive'>(({ config, data }) => {
-    if (!config.inverse && data.asset.visibility !== AssetVisibility.Archive) {
-      return { changes: { asset: { visibility: AssetVisibility.Archive } } };
+    case 'regex': {
+      const flags = caseSensitive ? '' : 'i';
+      const regex = new RegExp(searchPattern, flags);
+      return { workflow: { continue: regex.test(fileName) } };
     }
 
-    if (config.inverse && data.asset.visibility === AssetVisibility.Archive) {
-      return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
+    default: {
+      return {};
     }
+  }
+});
 
-    return {};
-  });
-};
+export const assetMissingTimeZoneFilter = wrapper<'assetMissingTimeZoneFilter'>(({ config, data }) => {
+  const hasTimeZone = !!data.asset?.exifInfo?.timeZone;
+  const needsTimeZone = config.inverse ? true : false;
+  return { workflow: { continue: hasTimeZone === needsTimeZone } };
+});
 
-export const assetLock = () => {
-  return wrapper<'assetLock'>(({ config, data }) => {
-    if (!config.inverse && data.asset.visibility !== AssetVisibility.Locked) {
-      return { changes: { asset: { visibility: AssetVisibility.Locked } } };
-    }
+export const assetLocationFilter = wrapper<'assetLocationFilter'>(({ config, data }) => {
+  if (
+    (config.region?.country && config.region.country !== data.asset.exifInfo?.country) ||
+    (config.region?.state && config.region.state !== data.asset.exifInfo?.state) ||
+    (config.region?.city && config.region.city !== data.asset.exifInfo?.city)
+  ) {
+    return { workflow: { continue: false } };
+  }
 
-    if (config.inverse && data.asset.visibility === AssetVisibility.Locked) {
-      return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
-    }
+  const configLat = Number.parseFloat(config.coordinate?.latitude ?? '');
+  const configLon = Number.parseFloat(config.coordinate?.longitude ?? '');
 
-    return {};
-  });
-};
+  if (Number.isNaN(configLat) || Number.isNaN(configLat)) {
+    return { workflow: { continue: true } };
+  }
+
+  const assetLat = data.asset.exifInfo?.latitude;
+  const assetLon = data.asset.exifInfo?.longitude;
+
+  if (assetLat === undefined || assetLat === null || assetLon === undefined || assetLon === null) {
+    return { workflow: { continue: false } };
+  }
+
+  const earthDiameter = 12742;
+  const deg = Math.PI / 180;
+  const delta = Math.asin(
+    Math.sqrt(
+      Math.pow(Math.sin((assetLat * deg - configLat * deg) / 2), 2) +
+        Math.cos(assetLat * deg) *
+          Math.cos(configLat * deg) *
+          Math.pow(Math.sin((assetLon * deg - configLon * deg) / 2), 2),
+    ),
+  );
+
+  return { workflow: { continue: earthDiameter * delta <= (config.coordinate?.radius ?? 0) } };
+});
+
+export const assetTypeFilter = wrapper<'assetTypeFilter'>(({ config, data }) => {
+  return { workflow: { continue: config.allowedTypes.includes(data.asset.type) } };
+});
+
+export const assetFavorite = wrapper<'assetFavorite'>(({ config, data }) => {
+  const target = config.inverse ? false : true;
+  if (target !== data.asset.isFavorite) {
+    return {
+      changes: {
+        asset: { isFavorite: target },
+      },
+    };
+  }
+});
+
+export const assetVisibility = wrapper<'assetVisibility'>(({ config }) => ({
+  changes: { asset: { visibility: config.visibility as AssetVisibility } },
+}));
+
+export const assetArchive = wrapper<'assetArchive'>(({ config, data }) => {
+  if (!config.inverse && data.asset.visibility !== AssetVisibility.Archive) {
+    return { changes: { asset: { visibility: AssetVisibility.Archive } } };
+  }
+
+  if (config.inverse && data.asset.visibility === AssetVisibility.Archive) {
+    return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
+  }
+
+  return {};
+});
+
+export const assetLock = wrapper<'assetLock'>(({ config, data }) => {
+  if (!config.inverse && data.asset.visibility !== AssetVisibility.Locked) {
+    return { changes: { asset: { visibility: AssetVisibility.Locked } } };
+  }
+
+  if (config.inverse && data.asset.visibility === AssetVisibility.Locked) {
+    return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
+  }
+
+  return {};
+});
 
 // export const assetTrash = () => {
 //   // TODO use trash/untrash host functions
 //   return wrapper<WorkflowType.AssetV1, { inverse?: boolean }>(() => ({}));
 // };
 
-export const assetAddToAlbums = () => {
-  return wrapper<'assetAddToAlbums'>(({ config, data, functions }) => {
-    const assetId = data.asset.id;
+export const assetAddToAlbums = wrapper<'assetAddToAlbums'>(({ config, data, functions }) => {
+  const assetId = data.asset.id;
 
-    if (config.albumIds.length === 0) {
-      if (!config.albumName) {
-        return {};
-      }
-
-      const [existing] = functions.searchAlbums({ name: config.albumName });
-      if (!existing) {
-        const created = functions.createAlbum({ albumName: config.albumName, assetIds: [assetId] });
-        config.albumIds.push(created.id);
-        return {};
-      }
-
-      config.albumIds.push(existing.id);
-    }
-
-    if (config.albumIds.length === 1) {
-      functions.addAssetsToAlbum(config.albumIds[0], [assetId]);
+  if (config.albumIds.length === 0) {
+    if (!config.albumName) {
       return {};
     }
 
-    functions.addAssetsToAlbums({ albumIds: config.albumIds, assetIds: [assetId] });
+    const [existing] = functions.searchAlbums({ name: config.albumName });
+    if (!existing) {
+      const created = functions.createAlbum({ albumName: config.albumName, assetIds: [assetId] });
+      config.albumIds.push(created.id);
+      return {};
+    }
+
+    config.albumIds.push(existing.id);
+  }
+
+  if (config.albumIds.length === 1) {
+    functions.addAssetsToAlbum(config.albumIds[0], [assetId]);
     return {};
-  });
-};
+  }
+
+  functions.addAssetsToAlbums({ albumIds: config.albumIds, assetIds: [assetId] });
+  return {};
+});

packages/plugin-core/tsconfig.json

@@ -13,7 +13,7 @@
     "skipLibCheck": true, // Skip type checking of declaration files
     "strict": true, // Enable all strict type-checking options
     "target": "es2020", // Specify ECMAScript target version
-    "types": ["./src/index.d.ts", "./node_modules/@extism/js-pdk"] // Specify a list of type definition files to be included in the compilation
+    "types": ["./dist/index.d.ts", "./node_modules/@extism/js-pdk"] // Specify a list of type definition files to be included in the compilation
   },
   "exclude": [
     "node_modules" // Exclude the node_modules directory

packages/plugin-sdk/esbuild.js

@@ -1,11 +1,12 @@
 import esbuild from 'esbuild';
 
 esbuild.build({
-  entryPoints: ['src/index.ts'],
+  entryPoints: ['src/index.ts', 'src/cli.ts'],
   outdir: 'dist',
   bundle: true,
   sourcemap: false,
   minify: false,
   format: 'esm',
+  platform: 'node',
   target: ['es2020'],
 });

packages/plugin-sdk/package.json

@@ -21,6 +21,9 @@
   "files": [
     "dist"
   ],
+  "bin": {
+    "plugin-sdk": "./plugin-sdk.mjs"
+  },
   "keywords": [],
   "author": "",
   "license": "GNU Affero General Public License version 3",
@@ -35,5 +38,8 @@
   },
   "peerDependencies": {
     "@extism/js-pdk": "^1.1.1"
+  },
+  "dependencies": {
+    "commander": "^15.0.0"
   }
 }

packages/plugin-sdk/plugin-sdk.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "./dist/cli.js";

packages/plugin-sdk/src/cli.ts

@@ -0,0 +1,43 @@
+import { Command } from 'commander';
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { dirname } from 'node:path';
+import { availableFunctions } from 'src/host-functions.js';
+
+const program = new Command('plugin-sdk');
+
+program
+  .command('prepareBuild')
+  .description('Generate .d.ts file required for extism')
+  .argument(
+    '[manifest]',
+    "Path to the plugins's manifest file",
+    'manifest.json',
+  )
+  .option('-o --output', 'Output file for generated types', 'dist/index.d.ts')
+  .action((manifest: string, { output }) => {
+    const content = readFileSync(manifest, { encoding: 'utf-8' });
+    const methods = (
+      JSON.parse(content) as { methods: { name: string }[] }
+    ).methods.map(({ name }) => name);
+    mkdirSync(dirname(output), { recursive: true });
+
+    writeFileSync(
+      output,
+      `
+declare module 'extism:host' {
+  interface user {
+${availableFunctions.map((functionName) => `    ${functionName}(ptr: PTR): I64;`).join('\n')}
+  }
+}
+
+declare module 'main' {
+${methods.map((method) => `  export function ${method}(): I32;`).join('\n')}
+}
+
+export type Manifest = ${content};
+
+      `,
+    );
+  });
+
+program.parse();

packages/plugin-sdk/src/host-functions.ts

@@ -6,14 +6,11 @@ import {
   type CreateAlbumDto,
 } from '@immich/sdk';
 
-// keep in sync with plugin-core/src/index.d.ts';
 declare module 'extism:host' {
-  interface user {
-    searchAlbums(ptr: PTR): I64;
-    createAlbum(ptr: PTR): I64;
-    addAssetsToAlbum(ptr: PTR): I64;
-    addAssetsToAlbums(ptr: PTR): I64;
-  }
+  interface user extends Record<
+    (typeof availableFunctions)[number],
+    (ptr: PTR) => I64
+  > {}
 }
 
 type AlbumsToAssets = {
@@ -34,6 +31,13 @@ type HostFunctionResult<T> =
 type QueryParams<T extends (...args: any) => any> = Parameters<T>[0];
 type AlbumSearchDto = QueryParams<typeof getAllAlbums>;
 
+export const availableFunctions = [
+  'searchAlbums',
+  'createAlbum',
+  'addAssetsToAlbum',
+  'addAssetsToAlbums',
+] as const;
+
 export const hostFunctions = (authToken: string) => {
   const host = Host.getFunctions();
   type HostFunctionName = keyof typeof host;
@@ -75,5 +79,5 @@ export const hostFunctions = (authToken: string) => {
       ),
     addAssetsToAlbums: ({ assetIds, albumIds }: AlbumsToAssets) =>
       call('addAssetsToAlbums', authToken, [{ albumIds, assetIds }]),
-  };
+  } satisfies Record<(typeof availableFunctions)[number], unknown>;
 };

packages/plugin-sdk/src/sdk.ts

@@ -67,7 +67,8 @@ export const getWrapper =
         functions: ReturnType<typeof hostFunctions>;
       },
     ) => WorkflowResponse<L> | undefined,
-  ) => {
+  ) =>
+  () => {
     const input = Host.inputString();
 
     try {

pnpm-lock.yaml

@@ -336,6 +336,10 @@ importers:
         version: 6.0.3
 
   packages/plugin-sdk:
+    dependencies:
+      commander:
+        specifier: ^15.0.0
+        version: 15.0.0
     devDependencies:
       '@extism/js-pdk':
         specifier: ^1.1.1