feat: pump doc references

misc/release/pump-version.sh

@@ -28,7 +28,7 @@ while getopts 's:m:' flag; do
 done
 
 CURRENT_SERVER=$(jq -r '.version' package.json)
-if ! NEXT_SERVER=$(pnpm --silent pump "$CURRENT_SERVER" "$SERVER_PUMP"); then
+if ! NEXT_SERVER=$(pnpm --silent pump "$SERVER_PUMP"); then
   echo "Fatal: failed to pump server version: $NEXT_SERVER" >&2
   exit 1
 fi
@@ -45,25 +45,21 @@ else
   exit 1
 fi
 
+echo "Pumping Server: $CURRENT_SERVER => $NEXT_SERVER"
 
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix server
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix packages/cli
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix web
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix e2e
+pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix packages/sdk
 
-if [ "$CURRENT_SERVER" != "$NEXT_SERVER" ]; then
-  echo "Pumping Server: $CURRENT_SERVER => $NEXT_SERVER"
+# copy version to open-api spec
+mise run //:open-api
 
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix server
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix packages/cli
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix web
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix e2e
-  pnpm version "$NEXT_SERVER" --no-git-tag-version --no-git-checks --prefix packages/sdk
+uv version --directory machine-learning "$NEXT_SERVER"
 
-  # copy version to open-api spec
-  mise run //:open-api
-
-  uv version --directory machine-learning "$NEXT_SERVER"
-
-  ./misc/release/archive-version.js "$NEXT_SERVER"
-fi
+./misc/release/archive-version.js "$NEXT_SERVER"
 
 if [ "$CURRENT_MOBILE" != "$NEXT_MOBILE" ]; then
   echo "Pumping Mobile: $CURRENT_MOBILE => $NEXT_MOBILE"

misc/release/pump-wrapper.js

@@ -1,7 +1,24 @@
-import { pump } from './pump.js';
+import { pump, PumpInvalidError, PumpUsageError } from './pump.js';
 
-const [versionRaw, type] = process.argv.slice(2);
-const { message, exitCode } = pump(versionRaw, type);
+const [type] = process.argv.slice(2);
 
-console.log(message);
-process.exit(exitCode);
+try {
+  const nextVersion = pump(type);
+  console.log(nextVersion);
+} catch (error) {
+  if (error instanceof PumpUsageError) {
+    console.log(
+      'Usage: ./pump-wrapper.js <minor|patch|premajor|preminor|prepatch|prerelease|release>',
+    );
+    process.exit(1);
+  }
+
+  if (error instanceof PumpInvalidError) {
+    console.log(
+      `Invalid pump: ${type}. Pumping from ${error.version} to ${error.newVersion} is not allowed.`,
+    );
+    process.exit(1);
+  }
+
+  throw error;
+}

misc/release/pump.js

@@ -1,44 +1,74 @@
+import { readFileSync, writeFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import semver, { SemVer } from 'semver';
 
-const printUsage = () => {
-  return {
-    message:
-      'Usage: ./pump_cli.js <semver> <minor|patch|premajor|preminor|prepatch|prerelease|release>',
-    exitCode: 1,
-  };
+const PROJECT_ROOT = join(dirname(fileURLToPath(import.meta.url)), '../..');
+
+const Files = {
+  PackageJson: join(PROJECT_ROOT, 'package.json'),
+  ExampleEnv: join(PROJECT_ROOT, 'docker/example.env'),
+  Docs: {
+    Env: join(PROJECT_ROOT, 'docs/docs/install/environment-variables.md'),
+    Upgrading: join(PROJECT_ROOT, 'docs/docs/install/upgrading.md'),
+  },
 };
 
-const isPrerelease = (version) => version.prerelease.length > 0;
+export class PumpUsageError extends Error {}
+export class PumpInvalidError extends Error {
+  constructor(options) {
+    super(`Invalid pump`);
+
+    this.version = options.version;
+    this.newVersion = options.newVersion;
+  }
+}
 
 /**
- * @param {SemVer} version
- * @returns {boolean}
+ * @param {string} type
  */
-const inc = (version, type) => `v${semver.inc(version, type, {}, 'rc')}`;
+export const pump = (type) => {
+  const currentVersionRaw = getCurrentVersion();
+  const nextVersionRaw = getNextVersion(currentVersionRaw, type);
+  const nextVersion = semver.parse(normalize(nextVersionRaw));
 
-/** @param {string} version */
-const normalize = (version) => {
-  if (version.startsWith('v')) {
-    version = version.slice(1);
+  if (nextVersion && type === 'release') {
+    const major = `v${nextVersion.major}`;
+
+    // sync major tag references in docs and example env file
+    findAndReplace(
+      Files.ExampleEnv,
+      /^IMMICH_VERSION=v\d+$/m,
+      `IMMICH_VERSION=${major}`,
+    );
+    findAndReplace(
+      Files.Docs.Env,
+      /(`IMMICH_VERSION`.*?)`v\d+`/,
+      `$1\`${major}\``,
+    );
+    findAndReplace(Files.Docs.Upgrading, /:v\d+/, `:${major}`);
   }
 
-  return version;
+  return nextVersionRaw;
 };
 
+const getCurrentVersion = () =>
+  JSON.parse(readFileSync(Files.PackageJson, 'utf8')).version;
+
 /**
  * @param {string} versionRaw
  * @param {string} type
  */
-export const pump = (versionRaw, type) => {
+export const getNextVersion = (versionRaw, type) => {
   if (!versionRaw) {
-    return printUsage();
+    throw new PumpUsageError();
   }
 
   versionRaw = normalize(versionRaw);
 
   const version = semver.parse(versionRaw);
   if (!version) {
-    return printUsage();
+    throw new PumpUsageError();
   }
 
   let newVersionRaw;
@@ -72,19 +102,19 @@ export const pump = (versionRaw, type) => {
     }
 
     default: {
-      return printUsage();
+      throw new PumpUsageError();
     }
   }
 
   if (!newVersionRaw) {
-    return printUsage();
+    throw new PumpUsageError();
   }
 
   newVersionRaw = normalize(newVersionRaw);
 
   const newVersion = semver.parse(newVersionRaw);
   if (!newVersion) {
-    return printUsage();
+    throw new PumpUsageError();
   }
 
   const invalidUpgrade =
@@ -95,11 +125,32 @@ export const pump = (versionRaw, type) => {
       version.patch !== newVersion.patch);
 
   if (!valid || invalidUpgrade) {
-    return {
-      message: `Invalid pump: ${type}. Pumping from ${versionRaw} to ${newVersionRaw} is not allowed.`,
-      exitCode: 1,
-    };
+    throw new PumpInvalidError({
+      type,
+      version: versionRaw,
+      newVersion: newVersionRaw,
+    });
   }
 
-  return { message: newVersionRaw, exitCode: 0 };
+  return newVersionRaw;
+};
+
+const findAndReplace = (path, pattern, replacement) =>
+  writeFileSync(path, readFileSync(path, 'utf8').replace(pattern, replacement));
+
+const isPrerelease = (version) => version.prerelease.length > 0;
+
+/**
+ * @param {SemVer} version
+ * @returns {boolean}
+ */
+const inc = (version, type) => `v${semver.inc(version, type, {}, 'rc')}`;
+
+/** @param {string} version */
+const normalize = (version) => {
+  if (version.startsWith('v')) {
+    version = version.slice(1);
+  }
+
+  return version;
 };

misc/release/pump.spec.js

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
-import { pump } from './pump';
+import { getNextVersion, PumpInvalidError, PumpUsageError } from './pump';
 
-describe(pump.name, () => {
+describe(getNextVersion.name, () => {
   describe('usage', () => {
     it.each([
       [],
@@ -10,10 +10,7 @@ describe(pump.name, () => {
       ['invalid', 'patch'],
       ['2.7.5', 'major'],
     ])('should not accept $0, $1 as inputs', (version, type) => {
-      expect(pump(version, type)).toEqual({
-        message: expect.stringContaining('Usage: '),
-        exitCode: 1,
-      });
+      expect(() => getNextVersion(version, type)).toThrow(PumpUsageError);
     });
   });
 
@@ -58,10 +55,7 @@ describe(pump.name, () => {
         it.each(group.items)(
           'should allow a $0 from $1 to $2',
           (type, version, next) => {
-            expect(pump(version, type)).toEqual({
-              message: next,
-              exitCode: 0,
-            });
+            expect(getNextVersion(version, type)).toEqual(next);
           },
         );
       });
@@ -77,10 +71,7 @@ describe(pump.name, () => {
         ['prerelease', 'v3.0.0'],
         ['release', 'v3.0.0'],
       ])('should not allow a $0 on $1', (type, version) => {
-        expect(pump(version, type)).toEqual({
-          message: expect.stringContaining('Invalid pump'),
-          exitCode: 1,
-        });
+        expect(() => getNextVersion(version, type)).toThrow(PumpInvalidError);
       });
     });
   });

packages/plugin-core/package.json

@@ -5,8 +5,8 @@
   "main": "src/index.ts",
   "scripts": {
     "build": "pnpm build:tsc && pnpm build: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"
+    "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"
   },
   "keywords": [],
   "author": "",

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

@@ -0,0 +1,27 @@
+// 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,157 +1,175 @@
 import { getWrapper } from '@immich/plugin-sdk';
 import { AssetVisibility } from '@immich/sdk';
-import type { Manifest } from '../dist/index.d.ts';
+import type manifestType from '../dist/manifest';
 
-const wrapper = getWrapper<Manifest>();
+const wrapper = getWrapper<manifestType>();
 
-export const assetFileFilter = wrapper<'assetFileFilter'>(({ data, config }) => {
-  const { pattern, matchType = 'contains', caseSensitive = false } = config;
+export const assetFileFilter = () => {
+  return 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) } };
+    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 } };
     }
 
-    case 'exact': {
-      return { workflow: { continue: searchName === 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 'startsWith': {
-      return { workflow: { continue: searchName.startsWith(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 'regex': {
-      const flags = caseSensitive ? '' : 'i';
-      const regex = new RegExp(searchPattern, flags);
-      return { workflow: { continue: regex.test(fileName) } };
+    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 } } };
     }
 
-    default: {
-      return {};
+    if (config.inverse && data.asset.visibility === AssetVisibility.Archive) {
+      return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
     }
-  }
-});
 
-export const assetMissingTimeZoneFilter = wrapper<'assetMissingTimeZoneFilter'>(({ config, data }) => {
-  const hasTimeZone = !!data.asset?.exifInfo?.timeZone;
-  const needsTimeZone = config.inverse ? true : false;
-  return { workflow: { continue: hasTimeZone === needsTimeZone } };
-});
+    return {};
+  });
+};
 
-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 } };
-  }
+export const assetLock = () => {
+  return wrapper<'assetLock'>(({ config, data }) => {
+    if (!config.inverse && data.asset.visibility !== AssetVisibility.Locked) {
+      return { changes: { asset: { visibility: AssetVisibility.Locked } } };
+    }
 
-  const configLat = Number.parseFloat(config.coordinate?.latitude ?? '');
-  const configLon = Number.parseFloat(config.coordinate?.longitude ?? '');
+    if (config.inverse && data.asset.visibility === AssetVisibility.Locked) {
+      return { changes: { asset: { visibility: AssetVisibility.Timeline } } };
+    }
 
-  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 {};
-});
+    return {};
+  });
+};
 
 // export const assetTrash = () => {
 //   // TODO use trash/untrash host functions
 //   return wrapper<WorkflowType.AssetV1, { inverse?: boolean }>(() => ({}));
 // };
 
-export const assetAddToAlbums = wrapper<'assetAddToAlbums'>(({ config, data, functions }) => {
-  const assetId = data.asset.id;
+export const assetAddToAlbums = () => {
+  return wrapper<'assetAddToAlbums'>(({ config, data, functions }) => {
+    const assetId = data.asset.id;
 
-  if (config.albumIds.length === 0) {
-    if (!config.albumName) {
+    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]);
       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]);
+    functions.addAssetsToAlbums({ albumIds: config.albumIds, assetIds: [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": ["./dist/index.d.ts", "./node_modules/@extism/js-pdk"] // Specify a list of type definition files to be included in the compilation
+    "types": ["./src/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,12 +1,11 @@
 import esbuild from 'esbuild';
 
 esbuild.build({
-  entryPoints: ['src/index.ts', 'src/cli.ts'],
+  entryPoints: ['src/index.ts'],
   outdir: 'dist',
   bundle: true,
   sourcemap: false,
   minify: false,
   format: 'esm',
-  platform: 'node',
   target: ['es2020'],
 });

packages/plugin-sdk/package.json

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

packages/plugin-sdk/plugin-sdk.mjs

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

packages/plugin-sdk/src/cli.ts

@@ -1,43 +0,0 @@
-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,11 +6,14 @@ import {
   type CreateAlbumDto,
 } from '@immich/sdk';
 
+// keep in sync with plugin-core/src/index.d.ts';
 declare module 'extism:host' {
-  interface user extends Record<
-    (typeof availableFunctions)[number],
-    (ptr: PTR) => I64
-  > {}
+  interface user {
+    searchAlbums(ptr: PTR): I64;
+    createAlbum(ptr: PTR): I64;
+    addAssetsToAlbum(ptr: PTR): I64;
+    addAssetsToAlbums(ptr: PTR): I64;
+  }
 }
 
 type AlbumsToAssets = {
@@ -31,13 +34,6 @@ 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;
@@ -79,5 +75,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,8 +67,7 @@ export const getWrapper =
         functions: ReturnType<typeof hostFunctions>;
       },
     ) => WorkflowResponse<L> | undefined,
-  ) =>
-  () => {
+  ) => {
     const input = Host.inputString();
 
     try {

pnpm-lock.yaml

@@ -336,10 +336,6 @@ 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