diff --git a/mobile/openapi/README.md b/mobile/openapi/README.md index b8bcbcebcd..22264857e0 100644 --- a/mobile/openapi/README.md +++ b/mobile/openapi/README.md @@ -184,6 +184,7 @@ Class | Method | HTTP request | Description *SearchApi* | [**searchSmart**](doc//SearchApi.md#searchsmart) | **POST** /search/smart | *ServerApi* | [**deleteServerLicense**](doc//ServerApi.md#deleteserverlicense) | **DELETE** /server/license | *ServerApi* | [**getAboutInfo**](doc//ServerApi.md#getaboutinfo) | **GET** /server/about | +*ServerApi* | [**getAndroidLinks**](doc//ServerApi.md#getandroidlinks) | **GET** /server/android-links | *ServerApi* | [**getServerConfig**](doc//ServerApi.md#getserverconfig) | **GET** /server/config | *ServerApi* | [**getServerFeatures**](doc//ServerApi.md#getserverfeatures) | **GET** /server/features | *ServerApi* | [**getServerLicense**](doc//ServerApi.md#getserverlicense) | **GET** /server/license | @@ -419,6 +420,7 @@ Class | Method | HTTP request | Description - [SearchResponseDto](doc//SearchResponseDto.md) - [SearchSuggestionType](doc//SearchSuggestionType.md) - [ServerAboutResponseDto](doc//ServerAboutResponseDto.md) + - [ServerApkLinksDto](doc//ServerApkLinksDto.md) - [ServerConfigDto](doc//ServerConfigDto.md) - [ServerFeaturesDto](doc//ServerFeaturesDto.md) - [ServerMediaTypesResponseDto](doc//ServerMediaTypesResponseDto.md) diff --git a/mobile/openapi/lib/api.dart b/mobile/openapi/lib/api.dart index ca33a5dea1..846db953dc 100644 --- a/mobile/openapi/lib/api.dart +++ b/mobile/openapi/lib/api.dart @@ -212,6 +212,7 @@ part 'model/search_facet_response_dto.dart'; part 'model/search_response_dto.dart'; part 'model/search_suggestion_type.dart'; part 'model/server_about_response_dto.dart'; +part 'model/server_apk_links_dto.dart'; part 'model/server_config_dto.dart'; part 'model/server_features_dto.dart'; part 'model/server_media_types_response_dto.dart'; diff --git a/mobile/openapi/lib/api/server_api.dart b/mobile/openapi/lib/api/server_api.dart index a0fd54f3d2..4220e67471 100644 --- a/mobile/openapi/lib/api/server_api.dart +++ b/mobile/openapi/lib/api/server_api.dart @@ -90,6 +90,47 @@ class ServerApi { return null; } + /// Performs an HTTP 'GET /server/android-links' operation and returns the [Response]. + Future<Response> getAndroidLinksWithHttpInfo() async { + // ignore: prefer_const_declarations + final apiPath = r'/server/android-links'; + + // ignore: prefer_final_locals + Object? postBody; + + final queryParams = <QueryParam>[]; + final headerParams = <String, String>{}; + final formParams = <String, String>{}; + + const contentTypes = <String>[]; + + + return apiClient.invokeAPI( + apiPath, + 'GET', + queryParams, + postBody, + headerParams, + formParams, + contentTypes.isEmpty ? null : contentTypes.first, + ); + } + + Future<ServerApkLinksDto?> getAndroidLinks() async { + final response = await getAndroidLinksWithHttpInfo(); + if (response.statusCode >= HttpStatus.badRequest) { + throw ApiException(response.statusCode, await _decodeBodyBytes(response)); + } + // When a remote server returns no body with a status of 204, we shall not decode it. + // At the time of writing this, `dart:convert` will throw an "Unexpected end of input" + // FormatException when trying to decode an empty string. + if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) { + return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'ServerApkLinksDto',) as ServerApkLinksDto; + + } + return null; + } + /// Performs an HTTP 'GET /server/config' operation and returns the [Response]. Future<Response> getServerConfigWithHttpInfo() async { // ignore: prefer_const_declarations diff --git a/mobile/openapi/lib/api_client.dart b/mobile/openapi/lib/api_client.dart index 1059655323..2657cece1c 100644 --- a/mobile/openapi/lib/api_client.dart +++ b/mobile/openapi/lib/api_client.dart @@ -480,6 +480,8 @@ class ApiClient { return SearchSuggestionTypeTypeTransformer().decode(value); case 'ServerAboutResponseDto': return ServerAboutResponseDto.fromJson(value); + case 'ServerApkLinksDto': + return ServerApkLinksDto.fromJson(value); case 'ServerConfigDto': return ServerConfigDto.fromJson(value); case 'ServerFeaturesDto': diff --git a/mobile/openapi/lib/model/server_apk_links_dto.dart b/mobile/openapi/lib/model/server_apk_links_dto.dart new file mode 100644 index 0000000000..086a2f172b --- /dev/null +++ b/mobile/openapi/lib/model/server_apk_links_dto.dart @@ -0,0 +1,123 @@ +// +// AUTO-GENERATED FILE, DO NOT MODIFY! +// +// @dart=2.18 + +// ignore_for_file: unused_element, unused_import +// ignore_for_file: always_put_required_named_parameters_first +// ignore_for_file: constant_identifier_names +// ignore_for_file: lines_longer_than_80_chars + +part of openapi.api; + +class ServerApkLinksDto { + /// Returns a new [ServerApkLinksDto] instance. + ServerApkLinksDto({ + required this.arm64v8a, + required this.armeabiv7a, + required this.universal, + required this.x8664, + }); + + String arm64v8a; + + String armeabiv7a; + + String universal; + + String x8664; + + @override + bool operator ==(Object other) => identical(this, other) || other is ServerApkLinksDto && + other.arm64v8a == arm64v8a && + other.armeabiv7a == armeabiv7a && + other.universal == universal && + other.x8664 == x8664; + + @override + int get hashCode => + // ignore: unnecessary_parenthesis + (arm64v8a.hashCode) + + (armeabiv7a.hashCode) + + (universal.hashCode) + + (x8664.hashCode); + + @override + String toString() => 'ServerApkLinksDto[arm64v8a=$arm64v8a, armeabiv7a=$armeabiv7a, universal=$universal, x8664=$x8664]'; + + Map<String, dynamic> toJson() { + final json = <String, dynamic>{}; + json[r'arm64v8a'] = this.arm64v8a; + json[r'armeabiv7a'] = this.armeabiv7a; + json[r'universal'] = this.universal; + json[r'x86_64'] = this.x8664; + return json; + } + + /// Returns a new [ServerApkLinksDto] instance and imports its values from + /// [value] if it's a [Map], null otherwise. + // ignore: prefer_constructors_over_static_methods + static ServerApkLinksDto? fromJson(dynamic value) { + upgradeDto(value, "ServerApkLinksDto"); + if (value is Map) { + final json = value.cast<String, dynamic>(); + + return ServerApkLinksDto( + arm64v8a: mapValueOfType<String>(json, r'arm64v8a')!, + armeabiv7a: mapValueOfType<String>(json, r'armeabiv7a')!, + universal: mapValueOfType<String>(json, r'universal')!, + x8664: mapValueOfType<String>(json, r'x86_64')!, + ); + } + return null; + } + + static List<ServerApkLinksDto> listFromJson(dynamic json, {bool growable = false,}) { + final result = <ServerApkLinksDto>[]; + if (json is List && json.isNotEmpty) { + for (final row in json) { + final value = ServerApkLinksDto.fromJson(row); + if (value != null) { + result.add(value); + } + } + } + return result.toList(growable: growable); + } + + static Map<String, ServerApkLinksDto> mapFromJson(dynamic json) { + final map = <String, ServerApkLinksDto>{}; + if (json is Map && json.isNotEmpty) { + json = json.cast<String, dynamic>(); // ignore: parameter_assignments + for (final entry in json.entries) { + final value = ServerApkLinksDto.fromJson(entry.value); + if (value != null) { + map[entry.key] = value; + } + } + } + return map; + } + + // maps a json object with a list of ServerApkLinksDto-objects as value to a dart map + static Map<String, List<ServerApkLinksDto>> mapListFromJson(dynamic json, {bool growable = false,}) { + final map = <String, List<ServerApkLinksDto>>{}; + if (json is Map && json.isNotEmpty) { + // ignore: parameter_assignments + json = json.cast<String, dynamic>(); + for (final entry in json.entries) { + map[entry.key] = ServerApkLinksDto.listFromJson(entry.value, growable: growable,); + } + } + return map; + } + + /// The list of required keys that must be present in a JSON. + static const requiredKeys = <String>{ + 'arm64v8a', + 'armeabiv7a', + 'universal', + 'x86_64', + }; +} + diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.json index 6aca3c349a..dee027f838 100644 --- a/open-api/immich-openapi-specs.json +++ b/open-api/immich-openapi-specs.json @@ -5275,6 +5275,38 @@ ] } }, + "/server/android-links": { + "get": { + "operationId": "getAndroidLinks", + "parameters": [], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServerApkLinksDto" + } + } + }, + "description": "" + } + }, + "security": [ + { + "bearer": [] + }, + { + "cookie": [] + }, + { + "api_key": [] + } + ], + "tags": [ + "Server" + ] + } + }, "/server/config": { "get": { "operationId": "getServerConfig", @@ -11959,6 +11991,29 @@ ], "type": "object" }, + "ServerApkLinksDto": { + "properties": { + "arm64v8a": { + "type": "string" + }, + "armeabiv7a": { + "type": "string" + }, + "universal": { + "type": "string" + }, + "x86_64": { + "type": "string" + } + }, + "required": [ + "arm64v8a", + "armeabiv7a", + "universal", + "x86_64" + ], + "type": "object" + }, "ServerConfigDto": { "properties": { "externalDomain": { diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.ts index 050fabca92..0c0ffd9796 100644 --- a/open-api/typescript-sdk/src/fetch-client.ts +++ b/open-api/typescript-sdk/src/fetch-client.ts @@ -1004,6 +1004,12 @@ export type ServerAboutResponseDto = { version: string; versionUrl: string; }; +export type ServerApkLinksDto = { + arm64v8a: string; + armeabiv7a: string; + universal: string; + x86_64: string; +}; export type ServerConfigDto = { externalDomain: string; isInitialized: boolean; @@ -2868,6 +2874,14 @@ export function getAboutInfo(opts?: Oazapfts.RequestOpts) { ...opts })); } +export function getAndroidLinks(opts?: Oazapfts.RequestOpts) { + return oazapfts.ok(oazapfts.fetchJson<{ + status: 200; + data: ServerApkLinksDto; + }>("/server/android-links", { + ...opts + })); +} export function getServerConfig(opts?: Oazapfts.RequestOpts) { return oazapfts.ok(oazapfts.fetchJson<{ status: 200; diff --git a/server/src/controllers/server.controller.ts b/server/src/controllers/server.controller.ts index 267fc42ef4..5bc78574c6 100644 --- a/server/src/controllers/server.controller.ts +++ b/server/src/controllers/server.controller.ts @@ -3,6 +3,7 @@ import { ApiNotFoundResponse, ApiTags } from '@nestjs/swagger'; import { LicenseKeyDto, LicenseResponseDto } from 'src/dtos/license.dto'; import { ServerAboutResponseDto, + ServerApkLinksDto, ServerConfigDto, ServerFeaturesDto, ServerMediaTypesResponseDto, @@ -34,6 +35,12 @@ export class ServerController { return this.service.getAboutInfo(); } + @Get('android-links') + @Authenticated() + getAndroidLinks(): ServerApkLinksDto { + return this.service.getAndroidLinks(); + } + @Get('storage') @Authenticated() getStorage(): Promise<ServerStorageResponseDto> { diff --git a/server/src/dtos/server.dto.ts b/server/src/dtos/server.dto.ts index e1f94dbaa5..47442ad4fb 100644 --- a/server/src/dtos/server.dto.ts +++ b/server/src/dtos/server.dto.ts @@ -37,6 +37,13 @@ export class ServerAboutResponseDto { thirdPartySupportUrl?: string; } +export class ServerApkLinksDto { + arm64v8a!: string; + armeabiv7a!: string; + universal!: string; + x86_64!: string; +} + export class ServerStorageResponseDto { diskSize!: string; diskUse!: string; diff --git a/server/src/services/server.service.ts b/server/src/services/server.service.ts index 9112c40a17..f07b8ee92e 100644 --- a/server/src/services/server.service.ts +++ b/server/src/services/server.service.ts @@ -5,6 +5,7 @@ import { OnEvent } from 'src/decorators'; import { LicenseKeyDto, LicenseResponseDto } from 'src/dtos/license.dto'; import { ServerAboutResponseDto, + ServerApkLinksDto, ServerConfigDto, ServerFeaturesDto, ServerMediaTypesResponseDto, @@ -48,6 +49,16 @@ export class ServerService extends BaseService { }; } + getAndroidLinks(): ServerApkLinksDto { + const baseURL = `https://github.com/immich-app/immich/releases/download/v${serverVersion.toString()}`; + return { + arm64v8a: `${baseURL}/app-arm64-v8a-release.apk`, + armeabiv7a: `${baseURL}/app-armeabi-v7a-release.apk`, + universal: `${baseURL}/app-release.apk`, + x86_64: `${baseURL}/app-x86_64-release.apk`, + }; + } + async getStorage(): Promise<ServerStorageResponseDto> { const libraryBase = StorageCore.getBaseFolder(StorageFolder.LIBRARY); const diskInfo = await this.storageRepository.checkDiskUsage(libraryBase);