Save library options per category

src/lib/data/Categories.ts

@@ -6,7 +6,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-import { CategoryType } from '@/lib/graphql/generated/graphql.ts';
+import { CategoryMetaType, CategoryType } from '@/lib/graphql/generated/graphql.ts';
 
 export const DEFAULT_CATEGORY_ID = 0;
 
@@ -15,6 +15,7 @@ export type CategoryNameInfo = Pick<CategoryType, 'name'>;
 export type CategoryDefaultInfo = Pick<CategoryType, 'default'>;
 export type CategoryUpdateInclusionInfo = Pick<CategoryType, 'includeInUpdate'>;
 export type CategoryDownloadInclusionInfo = Pick<CategoryType, 'includeInDownload'>;
+export type CategoryMetadataInfo = CategoryIdInfo & { meta: Pick<CategoryMetaType, 'key' | 'value'>[] };
 
 export class Categories {
     static getIds(categories: CategoryIdInfo[]): number[] {

src/lib/graphql/fragments/CategoryFragments.ts

@@ -24,6 +24,10 @@ export const CATEGORY_LIBRARY_FIELDS = gql`
     fragment CATEGORY_LIBRARY_FIELDS on CategoryType {
         ...CATEGORY_BASE_FIELDS
 
+        meta {
+            key
+            value
+        }
         mangas {
             totalCount
         }

src/lib/graphql/generated/graphql.ts

@@ -2713,7 +2713,7 @@ export type WebUiUpdateStatus = {
 
 export type CategoryBaseFieldsFragment = { __typename?: 'CategoryType', id: number, name: string, default: boolean, order: number };
 
-export type CategoryLibraryFieldsFragment = { __typename?: 'CategoryType', id: number, name: string, default: boolean, order: number, mangas: { __typename?: 'MangaNodeList', totalCount: number } };
+export type CategoryLibraryFieldsFragment = { __typename?: 'CategoryType', id: number, name: string, default: boolean, order: number, meta: Array<{ __typename?: 'CategoryMetaType', key: string, value: string }>, mangas: { __typename?: 'MangaNodeList', totalCount: number } };
 
 export type CategorySettingFieldsFragment = { __typename?: 'CategoryType', includeInUpdate: IncludeOrExclude, includeInDownload: IncludeOrExclude, id: number, name: string, default: boolean, order: number };
 
@@ -3253,7 +3253,7 @@ export type GetCategoriesLibraryQueryVariables = Exact<{
 }>;
 
 
-export type GetCategoriesLibraryQuery = { __typename?: 'Query', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, default: boolean, order: number, mangas: { __typename?: 'MangaNodeList', totalCount: number } }>, pageInfo: { __typename?: 'PageInfo', endCursor?: string | null, hasNextPage: boolean, hasPreviousPage: boolean, startCursor?: string | null } } };
+export type GetCategoriesLibraryQuery = { __typename?: 'Query', categories: { __typename?: 'CategoryNodeList', totalCount: number, nodes: Array<{ __typename?: 'CategoryType', id: number, name: string, default: boolean, order: number, meta: Array<{ __typename?: 'CategoryMetaType', key: string, value: string }>, mangas: { __typename?: 'MangaNodeList', totalCount: number } }>, pageInfo: { __typename?: 'PageInfo', endCursor?: string | null, hasNextPage: boolean, hasPreviousPage: boolean, startCursor?: string | null } } };
 
 export type GetCategoriesSettingsQueryVariables = Exact<{
   after?: InputMaybe<Scalars['Cursor']['input']>;

src/lib/metadata/categoryMetadata.ts

@@ -0,0 +1,96 @@
+/*
+ * 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/.
+ */
+
+import {
+    AllowedMetadataValueTypes,
+    AppMetadataKeys,
+    CategoryMetadataKeys,
+    GqlMetaHolder,
+    ICategoryMetadata,
+    LibraryOptions,
+    Metadata,
+} from '@/typings.ts';
+import { jsonSaveParse } from '@/util/HelperFunctions.ts';
+import { convertFromGqlMeta, getMetadataFrom, requestUpdateCategoryMetadata } from '@/lib/metadata/metadata.ts';
+import { defaultPromiseErrorHandler } from '@/util/defaultPromiseErrorHandler.ts';
+import { CategoryIdInfo } from '@/lib/data/Categories.ts';
+import { GridLayout } from '@/components/context/LibraryOptionsContext.tsx';
+
+export const getDefaultCategoryMetadata = (): ICategoryMetadata => ({
+    // display options
+    showContinueReadingButton: false,
+    showDownloadBadge: false,
+    showUnreadBadge: false,
+    gridLayout: GridLayout.Compact,
+
+    // sort options
+    sortDesc: undefined,
+    sortBy: undefined,
+
+    // filter options
+    hasDownloadedChapters: undefined,
+    hasBookmarkedChapters: undefined,
+    hasUnreadChapters: undefined,
+    hasDuplicateChapters: undefined,
+    hasTrackerBinding: {},
+    hasStatus: {} as LibraryOptions['hasStatus'],
+});
+
+const convertAppMetadataToGqlMetadata = (
+    metadata: Partial<ICategoryMetadata>,
+): Metadata<string, AllowedMetadataValueTypes> => ({
+    ...metadata,
+    hasTrackerBinding: metadata.hasTrackerBinding ? JSON.stringify(metadata.hasTrackerBinding) : undefined,
+    hasStatus: metadata.hasStatus ? JSON.stringify(metadata.hasStatus) : undefined,
+});
+
+const convertGqlMetadataToAppMetadata = (
+    metadata: Partial<Metadata<AppMetadataKeys, AllowedMetadataValueTypes>>,
+): ICategoryMetadata => ({
+    ...(metadata as unknown as ICategoryMetadata),
+    hasTrackerBinding:
+        jsonSaveParse<ICategoryMetadata['hasTrackerBinding']>(metadata.hasTrackerBinding as string) ??
+        (undefined as any),
+    hasStatus: jsonSaveParse<ICategoryMetadata['hasStatus']>(metadata.hasStatus as string) ?? (undefined as any),
+});
+
+const getCategoryMetadataWithDefaultValueFallback = (
+    meta?: Metadata,
+    defaultMetadata: ICategoryMetadata = getDefaultCategoryMetadata(),
+    applyMetadataMigration: boolean = true,
+): ICategoryMetadata =>
+    convertGqlMetadataToAppMetadata(
+        getMetadataFrom({ meta }, convertAppMetadataToGqlMetadata(defaultMetadata), applyMetadataMigration),
+    );
+
+export const getCategoryMetadata = (
+    { meta }: GqlMetaHolder = {},
+    defaultMetadata?: ICategoryMetadata,
+    applyMetadataMigration?: boolean,
+): ICategoryMetadata =>
+    getCategoryMetadataWithDefaultValueFallback(convertFromGqlMeta(meta), defaultMetadata, applyMetadataMigration);
+
+export const updateCategoryMetadata = async <
+    MetadataKeys extends CategoryMetadataKeys = CategoryMetadataKeys,
+    MetadataKey extends MetadataKeys = MetadataKeys,
+>(
+    category: CategoryIdInfo & GqlMetaHolder,
+    metadataKey: MetadataKey,
+    value: ICategoryMetadata[MetadataKey],
+): Promise<void[]> =>
+    requestUpdateCategoryMetadata(category, [
+        [metadataKey, convertAppMetadataToGqlMetadata({ [metadataKey]: value })[metadataKey]],
+    ]);
+
+export const createUpdateCategoryMetadata =
+    <Settings extends CategoryMetadataKeys>(
+        category: CategoryIdInfo & GqlMetaHolder,
+        handleError: (error: any) => void = defaultPromiseErrorHandler('createUpdateCategoryMetadata'),
+    ): ((...args: OmitFirst<Parameters<typeof updateCategoryMetadata<Settings>>>) => Promise<void | void[]>) =>
+    (metadataKey, value) =>
+        updateCategoryMetadata(category, metadataKey, value).catch(handleError);

src/lib/metadata/metadata.ts

@@ -34,6 +34,24 @@ const GLOBAL_METADATA_KEYS: AppMetadataKeys[] = [
     'showAddToLibraryCategorySelectDialog',
     'ignoreFilters',
     'removeMangaFromCategories',
+    'showTabSize',
+
+    // library category options
+    // filter
+    'hasDownloadedChapters',
+    'hasBookmarkedChapters',
+    'hasUnreadChapters',
+    'hasDuplicateChapters',
+    'hasTrackerBinding',
+    'hasStatus',
+    // sort
+    'sortBy',
+    'sortDesc',
+    // display
+    'showDownloadBadge',
+    'showUnreadBadge',
+    'showTabSize',
+    'showContinueReadingButton',
 
     // client
     'devices',
@@ -162,6 +180,10 @@ const convertValueFromMetadata = <T extends AllowedMetadataValueTypes = AllowedM
         return undefined as T;
     }
 
+    if (value === 'null') {
+        return null as T;
+    }
+
     return value as T;
 };
 

src/lib/metadata/metadataServerSettings.ts

@@ -31,6 +31,7 @@ export const getDefaultSettings = (): MetadataServerSettings => ({
     showAddToLibraryCategorySelectDialog: true,
     ignoreFilters: false,
     removeMangaFromCategories: false,
+    showTabSize: false,
 
     // client
     devices: [DEFAULT_DEVICE],