self-hosted/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-06-17 03:47:45 +02:00
Code Issues Releases Activity

refactor(server): use UUID dto in asset controller (#2641)

Browse Source 
* refactor: assetId => id

* chore: open api

* chore: remove unused dto

* fix(web): assetId => id

* fix: web test
This commit is contained in:
Jason Rasmussen
2023-06-01 22:19:25 -04:00
committed by GitHub
parent 422ad20641
commit a9fb1d435a
16 changed files with 184 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
web/src/api/open-api/api.ts generated
View File

@ -4847,16 +4847,16 @@ export const AssetApiAxiosParamCreator = function (configuration?: Configuration
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadFile: async (assetId: string, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'assetId' is not null or undefined
assertParamExists('downloadFile', 'assetId', assetId)
const localVarPath = `/asset/download/{assetId}`
.replace(`{${"assetId"}}`, encodeURIComponent(String(assetId)));
downloadFile: async (id: string, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('downloadFile', 'id', id)
const localVarPath = `/asset/download/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
@ -5097,16 +5097,16 @@ export const AssetApiAxiosParamCreator = function (configuration?: Configuration
},
/**
* Get a single asset\'s information
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetById: async (assetId: string, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'assetId' is not null or undefined
assertParamExists('getAssetById', 'assetId', assetId)
const localVarPath = `/asset/assetById/{assetId}`
.replace(`{${"assetId"}}`, encodeURIComponent(String(assetId)));
getAssetById: async (id: string, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('getAssetById', 'id', id)
const localVarPath = `/asset/assetById/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
@ -5308,17 +5308,17 @@ export const AssetApiAxiosParamCreator = function (configuration?: Configuration
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {ThumbnailFormat} [format]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetThumbnail: async (assetId: string, format?: ThumbnailFormat, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'assetId' is not null or undefined
assertParamExists('getAssetThumbnail', 'assetId', assetId)
const localVarPath = `/asset/thumbnail/{assetId}`
.replace(`{${"assetId"}}`, encodeURIComponent(String(assetId)));
getAssetThumbnail: async (id: string, format?: ThumbnailFormat, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('getAssetThumbnail', 'id', id)
const localVarPath = `/asset/thumbnail/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
@ -5628,18 +5628,18 @@ export const AssetApiAxiosParamCreator = function (configuration?: Configuration
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {boolean} [isThumb]
* @param {boolean} [isWeb]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
serveFile: async (assetId: string, isThumb?: boolean, isWeb?: boolean, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'assetId' is not null or undefined
assertParamExists('serveFile', 'assetId', assetId)
const localVarPath = `/asset/file/{assetId}`
.replace(`{${"assetId"}}`, encodeURIComponent(String(assetId)));
serveFile: async (id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('serveFile', 'id', id)
const localVarPath = `/asset/file/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
@ -5685,18 +5685,18 @@ export const AssetApiAxiosParamCreator = function (configuration?: Configuration
},
/**
* Update an asset
* @param {string} assetId
* @param {string} id
* @param {UpdateAssetDto} updateAssetDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateAsset: async (assetId: string, updateAssetDto: UpdateAssetDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'assetId' is not null or undefined
assertParamExists('updateAsset', 'assetId', assetId)
updateAsset: async (id: string, updateAssetDto: UpdateAssetDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'id' is not null or undefined
assertParamExists('updateAsset', 'id', id)
// verify required parameter 'updateAssetDto' is not null or undefined
assertParamExists('updateAsset', 'updateAssetDto', updateAssetDto)
const localVarPath = `/asset/{assetId}`
.replace(`{${"assetId"}}`, encodeURIComponent(String(assetId)));
const localVarPath = `/asset/{id}`
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
@ -5933,13 +5933,13 @@ export const AssetApiFp = function(configuration?: Configuration) {
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async downloadFile(assetId: string, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadFile(assetId, key, options);
async downloadFile(id: string, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.downloadFile(id, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
@ -5990,13 +5990,13 @@ export const AssetApiFp = function(configuration?: Configuration) {
},
/**
* Get a single asset\'s information
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getAssetById(assetId: string, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssetResponseDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetById(assetId, key, options);
async getAssetById(id: string, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssetResponseDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetById(id, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
@ -6039,14 +6039,14 @@ export const AssetApiFp = function(configuration?: Configuration) {
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {ThumbnailFormat} [format]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getAssetThumbnail(assetId: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetThumbnail(assetId, format, key, options);
async getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getAssetThumbnail(id, format, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
@ -6112,26 +6112,26 @@ export const AssetApiFp = function(configuration?: Configuration) {
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {boolean} [isThumb]
* @param {boolean} [isWeb]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async serveFile(assetId: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.serveFile(assetId, isThumb, isWeb, key, options);
async serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.serveFile(id, isThumb, isWeb, key, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Update an asset
* @param {string} assetId
* @param {string} id
* @param {UpdateAssetDto} updateAssetDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async updateAsset(assetId: string, updateAssetDto: UpdateAssetDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssetResponseDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAsset(assetId, updateAssetDto, options);
async updateAsset(id: string, updateAssetDto: UpdateAssetDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AssetResponseDto>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.updateAsset(id, updateAssetDto, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
@ -6225,13 +6225,13 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
downloadFile(assetId: string, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.downloadFile(assetId, key, options).then((request) => request(axios, basePath));
downloadFile(id: string, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.downloadFile(id, key, options).then((request) => request(axios, basePath));
},
/**
*
@ -6277,13 +6277,13 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
},
/**
* Get a single asset\'s information
* @param {string} assetId
* @param {string} id
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetById(assetId: string, key?: string, options?: any): AxiosPromise<AssetResponseDto> {
return localVarFp.getAssetById(assetId, key, options).then((request) => request(axios, basePath));
getAssetById(id: string, key?: string, options?: any): AxiosPromise<AssetResponseDto> {
return localVarFp.getAssetById(id, key, options).then((request) => request(axios, basePath));
},
/**
*
@ -6321,14 +6321,14 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {ThumbnailFormat} [format]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getAssetThumbnail(assetId: string, format?: ThumbnailFormat, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.getAssetThumbnail(assetId, format, key, options).then((request) => request(axios, basePath));
getAssetThumbnail(id: string, format?: ThumbnailFormat, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.getAssetThumbnail(id, format, key, options).then((request) => request(axios, basePath));
},
/**
*
@ -6387,25 +6387,25 @@ export const AssetApiFactory = function (configuration?: Configuration, basePath
},
/**
*
* @param {string} assetId
* @param {string} id
* @param {boolean} [isThumb]
* @param {boolean} [isWeb]
* @param {string} [key]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
serveFile(assetId: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.serveFile(assetId, isThumb, isWeb, key, options).then((request) => request(axios, basePath));
serveFile(id: string, isThumb?: boolean, isWeb?: boolean, key?: string, options?: any): AxiosPromise<File> {
return localVarFp.serveFile(id, isThumb, isWeb, key, options).then((request) => request(axios, basePath));
},
/**
* Update an asset
* @param {string} assetId
* @param {string} id
* @param {UpdateAssetDto} updateAssetDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateAsset(assetId: string, updateAssetDto: UpdateAssetDto, options?: any): AxiosPromise<AssetResponseDto> {
return localVarFp.updateAsset(assetId, updateAssetDto, options).then((request) => request(axios, basePath));
updateAsset(id: string, updateAssetDto: UpdateAssetDto, options?: any): AxiosPromise<AssetResponseDto> {
return localVarFp.updateAsset(id, updateAssetDto, options).then((request) => request(axios, basePath));
},
/**
*
@ -6541,7 +6541,7 @@ export interface AssetApiDownloadFileRequest {
* @type {string}
* @memberof AssetApiDownloadFile
*/
readonly assetId: string
readonly id: string
/**
*
@ -6653,7 +6653,7 @@ export interface AssetApiGetAssetByIdRequest {
* @type {string}
* @memberof AssetApiGetAssetById
*/
readonly assetId: string
readonly id: string
/**
*
@ -6702,7 +6702,7 @@ export interface AssetApiGetAssetThumbnailRequest {
* @type {string}
* @memberof AssetApiGetAssetThumbnail
*/
readonly assetId: string
readonly id: string
/**
*
@ -6807,7 +6807,7 @@ export interface AssetApiServeFileRequest {
* @type {string}
* @memberof AssetApiServeFile
*/
readonly assetId: string
readonly id: string
/**
*
@ -6842,7 +6842,7 @@ export interface AssetApiUpdateAssetRequest {
* @type {string}
* @memberof AssetApiUpdateAsset
*/
readonly assetId: string
readonly id: string
/**
*
@ -7038,7 +7038,7 @@ export class AssetApi extends BaseAPI {
* @memberof AssetApi
*/
public downloadFile(requestParameters: AssetApiDownloadFileRequest, options?: AxiosRequestConfig) {
return AssetApiFp(this.configuration).downloadFile(requestParameters.assetId, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
return AssetApiFp(this.configuration).downloadFile(requestParameters.id, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
}
/**
@ -7092,7 +7092,7 @@ export class AssetApi extends BaseAPI {
* @memberof AssetApi
*/
public getAssetById(requestParameters: AssetApiGetAssetByIdRequest, options?: AxiosRequestConfig) {
return AssetApiFp(this.configuration).getAssetById(requestParameters.assetId, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
return AssetApiFp(this.configuration).getAssetById(requestParameters.id, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
}
/**
@ -7145,7 +7145,7 @@ export class AssetApi extends BaseAPI {
* @memberof AssetApi
*/
public getAssetThumbnail(requestParameters: AssetApiGetAssetThumbnailRequest, options?: AxiosRequestConfig) {
return AssetApiFp(this.configuration).getAssetThumbnail(requestParameters.assetId, requestParameters.format, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
return AssetApiFp(this.configuration).getAssetThumbnail(requestParameters.id, requestParameters.format, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
}
/**
@ -7220,7 +7220,7 @@ export class AssetApi extends BaseAPI {
* @memberof AssetApi
*/
public serveFile(requestParameters: AssetApiServeFileRequest, options?: AxiosRequestConfig) {
return AssetApiFp(this.configuration).serveFile(requestParameters.assetId, requestParameters.isThumb, requestParameters.isWeb, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
return AssetApiFp(this.configuration).serveFile(requestParameters.id, requestParameters.isThumb, requestParameters.isWeb, requestParameters.key, options).then((request) => request(this.axios, this.basePath));
}
/**
@ -7231,7 +7231,7 @@ export class AssetApi extends BaseAPI {
* @memberof AssetApi
*/
public updateAsset(requestParameters: AssetApiUpdateAssetRequest, options?: AxiosRequestConfig) {
return AssetApiFp(this.configuration).updateAsset(requestParameters.assetId, requestParameters.updateAssetDto, options).then((request) => request(this.axios, this.basePath));
return AssetApiFp(this.configuration).updateAsset(requestParameters.id, requestParameters.updateAssetDto, options).then((request) => request(this.axios, this.basePath));
}
/**

2
web/src/lib/components/album-page/__tests__/album-card.spec.ts
View File

@ -87,7 +87,7 @@ describe('AlbumCard component', () => {
expect(apiMock.assetApi.getAssetThumbnail).toHaveBeenCalledTimes(1);
expect(apiMock.assetApi.getAssetThumbnail).toHaveBeenCalledWith(
{
assetId: 'thumbnailIdOne',
id: 'thumbnailIdOne',
format: ThumbnailFormat.Jpeg
},
{ responseType: 'blob' }

2
web/src/lib/components/album-page/album-card.svelte
View File

@ -37,7 +37,7 @@
const { data } = await api.assetApi.getAssetThumbnail(
{
assetId: thubmnailId,
id: thubmnailId,
format: ThumbnailFormat.Jpeg
},
{

6
web/src/lib/components/asset-viewer/asset-viewer.svelte
View File

@ -138,7 +138,7 @@
$downloadAssets[imageFileName] = 0;
const { data, status } = await api.assetApi.downloadFile(
{ assetId, key },
{ id: assetId, key },
{
responseType: 'blob',
onDownloadProgress: (progressEvent) => {
@ -216,7 +216,7 @@
const toggleFavorite = async () => {
const { data } = await api.assetApi.updateAsset({
assetId: asset.id,
id: asset.id,
updateAssetDto: {
isFavorite: !asset.isFavorite
}
@ -269,7 +269,7 @@
const toggleArchive = async () => {
try {
const { data } = await api.assetApi.updateAsset({
assetId: asset.id,
id: asset.id,
updateAssetDto: {
isArchived: !asset.isArchived
}

4
web/src/lib/components/asset-viewer/detail-panel.svelte
View File

@ -22,7 +22,7 @@
$: {
// Get latest description from server
if (asset.id) {
api.assetApi.getAssetById({ assetId: asset.id }).then((res) => {
api.assetApi.getAssetById({ id: asset.id }).then((res) => {
people = res.data?.people || [];
textarea.value = res.data?.exifInfo?.description || '';
});
@ -66,7 +66,7 @@
dispatch('description-focus-out');
try {
await api.assetApi.updateAsset({
assetId: asset.id,
id: asset.id,
updateAssetDto: {
description: description
}

2
web/src/lib/components/asset-viewer/photo-viewer.svelte
View File

@ -29,7 +29,7 @@
const loadAssetData = async () => {
try {
const { data } = await api.assetApi.serveFile(
{ assetId: asset.id, isThumb: false, isWeb: true, key: publicSharedKey },
{ id: asset.id, isThumb: false, isWeb: true, key: publicSharedKey },
{
responseType: 'blob'
}

2
web/src/lib/components/photos-page/actions/archive-action.svelte
View File

@ -28,7 +28,7 @@
for (const asset of getAssets()) {
if (asset.isArchived !== isArchived) {
api.assetApi.updateAsset({ assetId: asset.id, updateAssetDto: { isArchived } });
api.assetApi.updateAsset({ id: asset.id, updateAssetDto: { isArchived } });
onAssetArchive(asset, isArchived);
cnt = cnt + 1;

2
web/src/lib/components/photos-page/actions/favorite-action.svelte
View File

@ -28,7 +28,7 @@
let cnt = 0;
for (const asset of getAssets()) {
if (asset.isFavorite !== isFavorite) {
api.assetApi.updateAsset({ assetId: asset.id, updateAssetDto: { isFavorite } });
api.assetApi.updateAsset({ id: asset.id, updateAssetDto: { isFavorite } });
onAssetFavorite(asset, isFavorite);
cnt = cnt + 1;
}

2
web/src/lib/components/sharedlinks-page/shared-link-card.svelte
View File

@ -30,7 +30,7 @@
assetId = link.assets[0].id;
}
const { data } = await api.assetApi.getAssetById({ assetId });
const { data } = await api.assetApi.getAssetById({ id: assetId });
return data;
};