@immich/sdk 2.1.0 → 2.2.0

package/.nvmrc

@@ -1 +1 @@
-22.20.0
+24.11.0

package/build/fetch-client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.1.0
+ * 2.2.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -66,6 +66,7 @@ export type SystemConfigSmtpTransportDto = {
     ignoreCert: boolean;
     password: string;
     port: number;
+    secure: boolean;
     username: string;
 };
 export type SystemConfigSmtpDto = {
@@ -238,6 +239,17 @@ export type UserPreferencesUpdateDto = {
     sharedLinks?: SharedLinksUpdate;
     tags?: TagsUpdate;
 };
+export type SessionResponseDto = {
+    appVersion: string | null;
+    createdAt: string;
+    current: boolean;
+    deviceOS: string;
+    deviceType: string;
+    expiresAt?: string;
+    id: string;
+    isPendingSyncReset: boolean;
+    updatedAt: string;
+};
 export type AssetStatsResponseDto = {
     images: number;
     total: number;
@@ -351,12 +363,17 @@ export type AssetResponseDto = {
     updatedAt: string;
     visibility: AssetVisibility;
 };
+export type ContributorCountResponseDto = {
+    assetCount: number;
+    userId: string;
+};
 export type AlbumResponseDto = {
     albumName: string;
     albumThumbnailAssetId: string | null;
     albumUsers: AlbumUserResponseDto[];
     assetCount: number;
     assets: AssetResponseDto[];
+    contributorCounts?: ContributorCountResponseDto[];
     createdAt: string;
     description: string;
     endDate?: string;
@@ -495,6 +512,15 @@ export type AssetBulkUploadCheckResult = {
 export type AssetBulkUploadCheckResponseDto = {
     results: AssetBulkUploadCheckResult[];
 };
+export type AssetCopyDto = {
+    albums?: boolean;
+    favorite?: boolean;
+    sharedLinks?: boolean;
+    sidecar?: boolean;
+    sourceId: string;
+    stack?: boolean;
+    targetId: string;
+};
 export type CheckExistingAssetsDto = {
     deviceAssetIds: string[];
     deviceId: string;
@@ -524,6 +550,32 @@ export type AssetMetadataResponseDto = {
 export type AssetMetadataUpsertDto = {
     items: AssetMetadataUpsertItemDto[];
 };
+export type AssetOcrResponseDto = {
+    assetId: string;
+    /** Confidence score for text detection box */
+    boxScore: number;
+    id: string;
+    /** Recognized text */
+    text: string;
+    /** Confidence score for text recognition */
+    textScore: number;
+    /** Normalized x coordinate of box corner 1 (0-1) */
+    x1: number;
+    /** Normalized x coordinate of box corner 2 (0-1) */
+    x2: number;
+    /** Normalized x coordinate of box corner 3 (0-1) */
+    x3: number;
+    /** Normalized x coordinate of box corner 4 (0-1) */
+    x4: number;
+    /** Normalized y coordinate of box corner 1 (0-1) */
+    y1: number;
+    /** Normalized y coordinate of box corner 2 (0-1) */
+    y2: number;
+    /** Normalized y coordinate of box corner 3 (0-1) */
+    y3: number;
+    /** Normalized y coordinate of box corner 4 (0-1) */
+    y4: number;
+};
 export type AssetMediaReplaceDto = {
     assetData: Blob;
     deviceAssetId: string;
@@ -539,6 +591,7 @@ export type SignUpDto = {
     password: string;
 };
 export type ChangePasswordDto = {
+    invalidateSessions?: boolean;
     newPassword: string;
     password: string;
 };
@@ -673,6 +726,7 @@ export type AllJobStatusResponseDto = {
     metadataExtraction: JobStatusDto;
     migration: JobStatusDto;
     notifications: JobStatusDto;
+    ocr: JobStatusDto;
     search: JobStatusDto;
     sidecar: JobStatusDto;
     smartSearch: JobStatusDto;
@@ -903,6 +957,7 @@ export type MetadataSearchDto = {
     libraryId?: string | null;
     make?: string;
     model?: string | null;
+    ocr?: string;
     order?: AssetOrder;
     originalFileName?: string;
     originalPath?: string;
@@ -975,6 +1030,7 @@ export type RandomSearchDto = {
     libraryId?: string | null;
     make?: string;
     model?: string | null;
+    ocr?: string;
     personIds?: string[];
     rating?: number;
     size?: number;
@@ -1010,6 +1066,7 @@ export type SmartSearchDto = {
     libraryId?: string | null;
     make?: string;
     model?: string | null;
+    ocr?: string;
     page?: number;
     personIds?: string[];
     query?: string;
@@ -1046,6 +1103,7 @@ export type StatisticsSearchDto = {
     libraryId?: string | null;
     make?: string;
     model?: string | null;
+    ocr?: string;
     personIds?: string[];
     rating?: number;
     state?: string | null;
@@ -1112,6 +1170,7 @@ export type ServerFeaturesDto = {
     map: boolean;
     oauth: boolean;
     oauthAutoLaunch: boolean;
+    ocr: boolean;
     passwordLogin: boolean;
     reverseGeocoding: boolean;
     search: boolean;
@@ -1181,16 +1240,6 @@ export type ServerVersionHistoryResponseDto = {
     id: string;
     version: string;
 };
-export type SessionResponseDto = {
-    createdAt: string;
-    current: boolean;
-    deviceOS: string;
-    deviceType: string;
-    expiresAt?: string;
-    id: string;
-    isPendingSyncReset: boolean;
-    updatedAt: string;
-};
 export type SessionCreateDto = {
     deviceOS?: string;
     deviceType?: string;
@@ -1198,6 +1247,7 @@ export type SessionCreateDto = {
     duration?: number;
 };
 export type SessionCreateResponseDto = {
+    appVersion: string | null;
     createdAt: string;
     current: boolean;
     deviceOS: string;
@@ -1357,6 +1407,7 @@ export type SystemConfigJobDto = {
     metadataExtraction: JobSettingsDto;
     migration: JobSettingsDto;
     notifications: JobSettingsDto;
+    ocr: JobSettingsDto;
     search: JobSettingsDto;
     sidecar: JobSettingsDto;
     smartSearch: JobSettingsDto;
@@ -1398,12 +1449,20 @@ export type FacialRecognitionConfig = {
     minScore: number;
     modelName: string;
 };
+export type OcrConfig = {
+    enabled: boolean;
+    maxResolution: number;
+    minDetectionScore: number;
+    minRecognitionScore: number;
+    modelName: string;
+};
 export type SystemConfigMachineLearningDto = {
     availabilityChecks: MachineLearningAvailabilityChecksDto;
     clip: ClipConfig;
     duplicateDetection: DuplicateDetectionConfig;
     enabled: boolean;
     facialRecognition: FacialRecognitionConfig;
+    ocr: OcrConfig;
     urls: string[];
 };
 export type SystemConfigMapDto = {
@@ -1705,6 +1764,12 @@ export declare function updateUserPreferencesAdmin({ id, userPreferencesUpdateDt
 export declare function restoreUserAdmin({ id }: {
     id: string;
 }, opts?: Oazapfts.RequestOpts): Promise<UserAdminResponseDto>;
+/**
+ * This endpoint is an admin-only route, and requires the `adminSession.read` permission.
+ */
+export declare function getUserSessionsAdmin({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts): Promise<SessionResponseDto[]>;
 /**
  * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
  */
@@ -1856,6 +1921,12 @@ export declare function updateAssets({ assetBulkUpdateDto }: {
 export declare function checkBulkUpload({ assetBulkUploadCheckDto }: {
     assetBulkUploadCheckDto: AssetBulkUploadCheckDto;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetBulkUploadCheckResponseDto>;
+/**
+ * This endpoint requires the `asset.copy` permission.
+ */
+export declare function copyAsset({ assetCopyDto }: {
+    assetCopyDto: AssetCopyDto;
+}, opts?: Oazapfts.RequestOpts): Promise<never>;
 /**
  * getAllUserAssetsByDeviceId
  */
@@ -1927,6 +1998,12 @@ export declare function getAssetMetadataByKey({ id, key }: {
     id: string;
     key: AssetMetadataKey;
 }, opts?: Oazapfts.RequestOpts): Promise<AssetMetadataResponseDto>;
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export declare function getAssetOcr({ id }: {
+    id: string;
+}, opts?: Oazapfts.RequestOpts): Promise<AssetOcrResponseDto[]>;
 /**
  * This endpoint requires the `asset.download` permission.
  */
@@ -2353,7 +2430,7 @@ export declare function getExploreData(opts?: Oazapfts.RequestOpts): Promise<Sea
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export declare function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }: {
+export declare function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }: {
     albumIds?: string[];
     city?: string | null;
     country?: string | null;
@@ -2370,6 +2447,7 @@ export declare function searchLargeAssets({ albumIds, city, country, createdAfte
     make?: string;
     minFileSize?: number;
     model?: string | null;
+    ocr?: string;
     personIds?: string[];
     rating?: number;
     size?: number;
@@ -2426,9 +2504,10 @@ export declare function searchAssetStatistics({ statisticsSearchDto }: {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export declare function getSearchSuggestions({ country, includeNull, make, model, state, $type }: {
+export declare function getSearchSuggestions({ country, includeNull, lensModel, make, model, state, $type }: {
     country?: string;
     includeNull?: boolean;
+    lensModel?: string;
     make?: string;
     model?: string;
     state?: string;
@@ -2945,6 +3024,7 @@ export declare enum Permission {
     AssetDownload = "asset.download",
     AssetUpload = "asset.upload",
     AssetReplace = "asset.replace",
+    AssetCopy = "asset.copy",
     AlbumCreate = "album.create",
     AlbumRead = "album.read",
     AlbumUpdate = "album.update",
@@ -3053,6 +3133,7 @@ export declare enum Permission {
     AdminUserRead = "adminUser.read",
     AdminUserUpdate = "adminUser.update",
     AdminUserDelete = "adminUser.delete",
+    AdminSessionRead = "adminSession.read",
     AdminAuthUnlinkAll = "adminAuth.unlinkAll"
 }
 export declare enum AssetMetadataKey {
@@ -3105,7 +3186,8 @@ export declare enum JobName {
     Sidecar = "sidecar",
     Library = "library",
     Notifications = "notifications",
-    BackupDatabase = "backupDatabase"
+    BackupDatabase = "backupDatabase",
+    Ocr = "ocr"
 }
 export declare enum JobCommand {
     Start = "start",
@@ -3126,7 +3208,8 @@ export declare enum SearchSuggestionType {
     State = "state",
     City = "city",
     CameraMake = "camera-make",
-    CameraModel = "camera-model"
+    CameraModel = "camera-model",
+    CameraLensModel = "camera-lens-model"
 }
 export declare enum SharedLinkType {
     Album = "ALBUM",

package/build/fetch-client.js

@@ -1,6 +1,6 @@
 /**
  * Immich
- * 2.1.0
+ * 2.2.0
  * DO NOT MODIFY - This file has been generated using oazapfts.
  * See https://www.npmjs.com/package/oazapfts
  */
@@ -164,6 +164,14 @@ export function restoreUserAdmin({ id }, opts) {
         method: "POST"
     }));
 }
+/**
+ * This endpoint is an admin-only route, and requires the `adminSession.read` permission.
+ */
+export function getUserSessionsAdmin({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/admin/users/${encodeURIComponent(id)}/sessions`, {
+        ...opts
+    }));
+}
 /**
  * This endpoint is an admin-only route, and requires the `adminUser.read` permission.
  */
@@ -397,6 +405,16 @@ export function checkBulkUpload({ assetBulkUploadCheckDto }, opts) {
         body: assetBulkUploadCheckDto
     })));
 }
+/**
+ * This endpoint requires the `asset.copy` permission.
+ */
+export function copyAsset({ assetCopyDto }, opts) {
+    return oazapfts.ok(oazapfts.fetchText("/assets/copy", oazapfts.json({
+        ...opts,
+        method: "PUT",
+        body: assetCopyDto
+    })));
+}
 /**
  * getAllUserAssetsByDeviceId
  */
@@ -500,6 +518,14 @@ export function getAssetMetadataByKey({ id, key }, opts) {
         ...opts
     }));
 }
+/**
+ * This endpoint requires the `asset.read` permission.
+ */
+export function getAssetOcr({ id }, opts) {
+    return oazapfts.ok(oazapfts.fetchJson(`/assets/${encodeURIComponent(id)}/ocr`, {
+        ...opts
+    }));
+}
 /**
  * This endpoint requires the `asset.download` permission.
  */
@@ -1190,7 +1216,7 @@ export function getExploreData(opts) {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }, opts) {
+export function searchLargeAssets({ albumIds, city, country, createdAfter, createdBefore, deviceId, isEncoded, isFavorite, isMotion, isNotInAlbum, isOffline, lensModel, libraryId, make, minFileSize, model, ocr, personIds, rating, size, state, tagIds, takenAfter, takenBefore, trashedAfter, trashedBefore, $type, updatedAfter, updatedBefore, visibility, withDeleted, withExif }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/search/large-assets${QS.query(QS.explode({
         albumIds,
         city,
@@ -1208,6 +1234,7 @@ export function searchLargeAssets({ albumIds, city, country, createdAfter, creat
         make,
         minFileSize,
         model,
+        ocr,
         personIds,
         rating,
         size,
@@ -1292,10 +1319,11 @@ export function searchAssetStatistics({ statisticsSearchDto }, opts) {
 /**
  * This endpoint requires the `asset.read` permission.
  */
-export function getSearchSuggestions({ country, includeNull, make, model, state, $type }, opts) {
+export function getSearchSuggestions({ country, includeNull, lensModel, make, model, state, $type }, opts) {
     return oazapfts.ok(oazapfts.fetchJson(`/search/suggestions${QS.query(QS.explode({
         country,
         includeNull,
+        lensModel,
         make,
         model,
         state,
@@ -2137,6 +2165,7 @@ export var Permission;
     Permission["AssetDownload"] = "asset.download";
     Permission["AssetUpload"] = "asset.upload";
     Permission["AssetReplace"] = "asset.replace";
+    Permission["AssetCopy"] = "asset.copy";
     Permission["AlbumCreate"] = "album.create";
     Permission["AlbumRead"] = "album.read";
     Permission["AlbumUpdate"] = "album.update";
@@ -2245,6 +2274,7 @@ export var Permission;
     Permission["AdminUserRead"] = "adminUser.read";
     Permission["AdminUserUpdate"] = "adminUser.update";
     Permission["AdminUserDelete"] = "adminUser.delete";
+    Permission["AdminSessionRead"] = "adminSession.read";
     Permission["AdminAuthUnlinkAll"] = "adminAuth.unlinkAll";
 })(Permission || (Permission = {}));
 export var AssetMetadataKey;
@@ -2306,6 +2336,7 @@ export var JobName;
     JobName["Library"] = "library";
     JobName["Notifications"] = "notifications";
     JobName["BackupDatabase"] = "backupDatabase";
+    JobName["Ocr"] = "ocr";
 })(JobName || (JobName = {}));
 export var JobCommand;
 (function (JobCommand) {
@@ -2331,6 +2362,7 @@ export var SearchSuggestionType;
     SearchSuggestionType["City"] = "city";
     SearchSuggestionType["CameraMake"] = "camera-make";
     SearchSuggestionType["CameraModel"] = "camera-model";
+    SearchSuggestionType["CameraLensModel"] = "camera-lens-model";
 })(SearchSuggestionType || (SearchSuggestionType = {}));
 export var SharedLinkType;
 (function (SharedLinkType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immich/sdk",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Auto-generated TypeScript SDK for the Immich API",
   "type": "module",
   "main": "./build/index.js",
@@ -16,7 +16,7 @@
     "@oazapfts/runtime": "^1.0.2"
   },
   "devDependencies": {
-    "@types/node": "^22.18.8",
+    "@types/node": "^22.18.12",
     "typescript": "^5.3.3"
   },
   "repository": {
@@ -25,7 +25,7 @@
     "directory": "open-api/typescript-sdk"
   },
   "volta": {
-    "node": "22.20.0"
+    "node": "24.11.0"
   },
   "scripts": {
     "build": "tsc"