Files
suwayomi-material-you-webui/src/features/metadata/services/MetadataReader.ts

159 lines
5.6 KiB
TypeScript
Raw Normal View History

2024-10-05 23:17:20 +02:00
/*
* Copyright (C) Contributors to the Suwayomi project
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*/
2026-03-11 00:11:29 +01:00
import type { useEffect } from 'react';
2025-08-15 22:02:58 +02:00
import { convertValueFromMetadata } from '@/features/metadata/services/MetadataConverter.ts';
2026-03-11 00:11:29 +01:00
import type {
2024-10-05 23:17:20 +02:00
AllowedMetadataValueTypes,
AppMetadataKeys,
Metadata,
MetadataHolder,
MetadataHolderType,
2025-08-15 22:02:58 +02:00
} from '@/features/metadata/Metadata.types.ts';
2026-03-11 00:11:29 +01:00
import type { MangaIdInfo } from '@/features/manga/Manga.types.ts';
2025-01-05 02:15:03 +01:00
2026-03-11 00:11:29 +01:00
import type { CategoryIdInfo } from '@/features/category/Category.types.ts';
2025-08-15 22:02:58 +02:00
import { doesMetadataKeyExistIn, getMetadataKey } from '@/features/metadata/Metadata.utils.ts';
import { MetadataChunker } from '@/features/metadata/services/MetadataChunker.ts';
2025-08-15 22:02:58 +02:00
import { applyMetadataMigrations } from '@/features/metadata/services/MetadataMigrations.ts';
2026-03-11 00:11:29 +01:00
import type { SourceIdInfo } from '@/features/source/Source.types.ts';
import type { ChapterIdInfo } from '@/features/chapter/Chapter.types.ts';
2025-08-15 22:02:58 +02:00
import { APP_METADATA } from '@/features/metadata/Metadata.constants.ts';
import { MetadataValueCache } from '@/features/metadata/services/MetadataValueCache.ts';
2024-10-05 23:17:20 +02:00
const getHolderId = (
type: MetadataHolderType,
metadataHolder:
| MetadataHolder
| (MangaIdInfo & MetadataHolder)
| (ChapterIdInfo & MetadataHolder)
| (CategoryIdInfo & MetadataHolder)
| (SourceIdInfo & MetadataHolder),
): string | number | undefined => {
switch (type) {
case 'global':
return undefined;
case 'manga':
return (metadataHolder as MangaIdInfo).id;
case 'chapter':
return (metadataHolder as ChapterIdInfo).id;
case 'category':
return (metadataHolder as CategoryIdInfo).id;
case 'source':
return (metadataHolder as SourceIdInfo).id;
default:
return undefined;
}
};
const getRawMetadataValueFrom = (
metadata: Metadata | undefined,
key: string,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
): string | undefined => {
if (metadata === undefined) {
return undefined;
}
const fullKey = getMetadataKey(key, prefixes);
if (doesMetadataKeyExistIn(metadata, fullKey) && metadata[fullKey] !== undefined) {
return metadata[fullKey];
}
if (MetadataChunker.isChunkedInMetadata(metadata, fullKey)) {
return MetadataChunker.reassembleChunkedValue(metadata, fullKey);
}
return undefined;
};
const getMetadataValueFrom = <Key extends AppMetadataKeys, Value extends AllowedMetadataValueTypes>(
metadata: Metadata | undefined,
key: Key,
defaultValue?: Value,
prefixes?: string[],
): Value | undefined => {
const rawValue = getRawMetadataValueFrom(metadata, key, prefixes);
if (rawValue === undefined) {
2024-10-05 23:17:20 +02:00
return defaultValue;
}
const convertedValue = convertValueFromMetadata(key, rawValue, defaultValue);
return APP_METADATA[key].toConstrainedValue?.(convertedValue) ?? convertedValue;
2024-10-05 23:17:20 +02:00
};
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: 'global',
metadataHolder: MetadataHolder,
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn?: typeof useEffect,
): METADATA;
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: 'manga',
metadataHolder: MangaIdInfo & MetadataHolder,
2024-10-05 23:17:20 +02:00
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn?: typeof useEffect,
): METADATA;
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: 'chapter',
metadataHolder: ChapterIdInfo & MetadataHolder,
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn?: typeof useEffect,
): METADATA;
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: 'category',
metadataHolder: CategoryIdInfo & MetadataHolder,
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn?: typeof useEffect,
): METADATA;
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: 'source',
2025-04-21 17:00:13 +02:00
metadataHolder: SourceIdInfo & MetadataHolder,
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn?: typeof useEffect,
): METADATA;
export function getMetadataFrom<METADATA extends Partial<Metadata<AppMetadataKeys, any>>>(
type: MetadataHolderType,
metadataHolder:
| MetadataHolder
| (MangaIdInfo & MetadataHolder)
| (ChapterIdInfo & MetadataHolder)
| (CategoryIdInfo & MetadataHolder)
2025-04-21 17:00:13 +02:00
| (SourceIdInfo & MetadataHolder),
metadataWithDefaultValues: METADATA,
2024-10-28 18:03:29 +01:00
prefixes?: string[],
useEffectFn: typeof useEffect = (fn: () => void) => fn(),
): METADATA {
2025-01-05 02:15:03 +01:00
const migratedMetadata = applyMetadataMigrations(type, metadataHolder, useEffectFn);
2024-10-05 23:17:20 +02:00
const appMetadata = {} as METADATA;
const holderId = getHolderId(type, metadataHolder);
2024-10-05 23:17:20 +02:00
Object.entries(metadataWithDefaultValues).forEach(([key, defaultValue]) => {
const rawValue = getRawMetadataValueFrom(migratedMetadata, key as AppMetadataKeys, prefixes);
const newValue = getMetadataValueFrom(migratedMetadata, key as AppMetadataKeys, defaultValue, prefixes);
appMetadata[key as AppMetadataKeys] = MetadataValueCache.getStableValue(
type,
holderId,
getMetadataKey(key, prefixes),
rawValue,
newValue,
2024-10-05 23:17:20 +02:00
);
});
return appMetadata;
}