Start journal entry pagination at 1 (#12298)

foundryvtt · Dec 18, 2023 · 8afc580 · 8afc580
1 parent 4dc49e7
commit 8afc580
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 3 deletions.
diff --git a/src/module/journal-entry/sheet.ts b/src/module/journal-entry/sheet.ts
@@ -8,12 +8,24 @@ class JournalSheetPF2e<TJournalEntry extends JournalEntry> extends JournalSheet<
  /** Use the system-themed styling only if the setting is enabled (on by default) */
  static override get defaultOptions(): DocumentSheetOptions {
  const options = super.defaultOptions;
+ options.sheetConfig &&=
+ Object.values(CONFIG.JournalEntry.sheetClasses).filter((c) => c.canConfigure).length > 1;
+
  const { theme } = this;
  if (theme) {
  options.classes.push(theme);
  }
  return options;
  }
+
+ /** Start pagination at 1 🤫 */
+ override async getData(options?: Partial<DocumentSheetOptions>): Promise<JournalSheetData<TJournalEntry>> {
+ const sheetData = await super.getData(options);
+ for (const entry of sheetData.toc) {
+ entry.number += 1;
+ }
+ return sheetData;
+ }
 }
 
 class JournalTextTinyMCESheetPF2e<

diff --git a/types/foundry/client/apps/forms/journal-sheet.d.ts b/types/foundry/client/apps/forms/journal-sheet.d.ts
@@ -1,4 +1,4 @@
-export {};
+import type { JournalEntryPageSource } from "../../../common/documents/journal-entry-page.d.ts";
 
 declare global {
  /**
@@ -56,7 +56,9 @@ declare global {
 
  protected override _getHeaderButtons(): ApplicationHeaderButton[];
 
- override getData(options?: Partial<DocumentSheetOptions>): DocumentSheetData<TJournalEntry>;
+ override getData(
+ options?: Partial<DocumentSheetOptions>,
+ ): JournalSheetData<TJournalEntry> | Promise<JournalSheetData<TJournalEntry>>;
 
  override get template(): string;
 
@@ -199,7 +201,7 @@ declare global {
  * Handle opening the context menu.
  * @param target The element the context menu has been triggered for.
  */
- _onContextMenuOpen(target: HTMLElement): void;
+ protected _onContextMenuOpen(target: HTMLElement): void;
 
  /**
  * Handle closing the context menu.
@@ -244,4 +246,19 @@ declare global {
  pageId?: string;
  pageIndex?: number;
  }
+
+ interface JournalSheetData<TDocument extends JournalEntry> extends DocumentSheetData<TDocument> {
+ collapseMode: {
+ label: string;
+ icon: string;
+ };
+ searchIcon: string;
+ searchTooltip: string;
+ toc: JournalSheetPageData[];
+ }
+
+ interface JournalSheetPageData extends JournalEntryPageSource {
+ number: 0;
+ ownershipCls: string;
+ }
 }
diff --git a/types/foundry/client/config.d.ts b/types/foundry/client/config.d.ts
@@ -146,6 +146,20 @@ declare global {
  Anchor: string;
  [key: string]: string;
  };
+ sheetClasses: Record<
+ string,
+ Record<
+ string,
+ {
+ id: string;
+ cls: typeof JournalSheet;
+ default: boolean;
+ label: string;
+ canConfigure: boolean;
+ canBeDefault: boolean;
+ }
+ >
+ >;
  sidebarIcon: string;
  };
 

diff --git a/types/foundry/common/documents/journal-entry-page.d.ts b/types/foundry/common/documents/journal-entry-page.d.ts
@@ -77,4 +77,6 @@ type JournalEntryPageSchema<
  _stats: fields.DocumentStatsField;
 };
 
+export type JournalEntryPageSource = SourceFromSchema<JournalEntryPageSchema>;
+
 export type CorePageType = "image" | "pdf" | "text" | "video";