@fiduswriter/books-document 0.1.27 → 0.1.29

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://git.fiduswriter.org/fiduswriter/fiduswriter-books-plugin-ts/raw/branch/main/logo.svg" alt="@fiduswriter/books-document" width="100" height="100">
+  <img src="https://git.fiduswriter.org/fiduswriter/fiduswriter-books-ts/raw/branch/main/logo.svg" alt="@fiduswriter/books-document" width="100" height="100">
 </p>
 
 <h1 align="center">@fiduswriter/books-document</h1>

package/dist/ui/book_dialog/dialog.d.ts

@@ -0,0 +1,98 @@
+/**
+ * The book edit dialog.
+ *
+ * A tabbed dialog that edits a book's metadata and settings, manages its
+ * chapter list (add/remove/reorder, part grouping and per-chapter part
+ * titles), picks the cover image, triggers a sanity check and starts an
+ * export.
+ *
+ * Everything host-specific is injected: see `./types.js`. The book *overview*
+ * page -- its datatable, bulk actions, sharing, copy and delete -- is not
+ * part of this component and stays with the host.
+ */
+import type { Book, Chapter } from "../../types.js";
+import { Dialog, FileSelector } from "fwtoolkit";
+import type { BookExportMenu } from "./export.js";
+import type { BookDialogImageDB, BookDialogInfo, BookDialogOptions, BookDialogPart } from "./types.js";
+/** The tabbed book editor. */
+export declare class BookDialog {
+    options: BookDialogOptions;
+    /** Whether this dialog creates a new book or edits an existing one. */
+    isNew: boolean;
+    /** The book being edited. A working copy, not the host's own record. */
+    book: Book;
+    documentList: BookDialogOptions["documentList"];
+    exportMenu: BookExportMenu;
+    /** Callbacks invoked after the book has been saved. */
+    onSave: Array<(book: Book) => Promise<unknown> | unknown>;
+    dialogParts: BookDialogPart[];
+    /** Cover images that are not part of the host's image database. */
+    bookImageDB: BookDialogImageDB;
+    dialog: Dialog | null;
+    constructor(options: BookDialogOptions);
+    /** The image database the dialog renders cover previews from. */
+    imageDB(): BookDialogImageDB;
+    /** The dialog's root element, or the document before it is opened. */
+    root(): ParentNode;
+    /** The bundle the tab templates are rendered from. */
+    bookInfo(): BookDialogInfo;
+    /** A brand new book with the dialog's default metadata and settings. */
+    createEmptyBook(): Book;
+    /**
+     * The dialog's working copy of an existing book.
+     *
+     * The record is copied shallowly -- the `chapters` array stays shared with
+     * the host's record, exactly as the Django backend's dialog behaved -- and
+     * the metadata block is merged onto a complete one so every form field
+     * has something to read back.
+     */
+    workingCopy(book: Book): Book;
+    /** Render and open the dialog. */
+    open(): void;
+    /** Whether the book is only readable, i.e. not editable. */
+    readOnly(): boolean;
+    /**
+     * Let the user pick a DOCX/ODT template file and hand it to the host.
+     *
+     * The book is saved first, because a freshly created book has no id the
+     * host could attach a template to.
+     */
+    bindTemplateInput(dialog: Dialog, inputId: string, rowId: string, applyTemplate: (book: Book, template: string) => void, saveTemplate?: (book: Book, file: File) => Promise<string | null>): void;
+    /** Replace the markup of one of the dialog's rows. */
+    refreshRow(rowId: string, html: string): void;
+    /** Re-render the chapter list. */
+    refreshChapterList(): void;
+    /**
+     * Add or remove the encrypted-chapters notice that lives alongside the
+     * chapter list. Called after any operation that changes book.chapters so
+     * the notice stays in sync.
+     */
+    updateChapterNotice(): void;
+    /** Open a sub-dialog to edit a chapter's part title. */
+    editChapterDialog(chapter: Chapter): void;
+    /** Let the user pick the cover image through the host's image picker. */
+    selectCoverImage(): Promise<void>;
+    /**
+     * Persist the edited book through the host and notify the save callbacks.
+     *
+     * Reads the metadata form fields back into the book, so it must only be
+     * called while the dialog is open.
+     */
+    saveBook(): Promise<unknown>;
+    /**
+     * Move a chapter one position up or down the list.
+     *
+     * @param docId - Id of the chapter document to move.
+     * @param offset - `-1` to move up, `1` to move down.
+     */
+    moveChapter(docId: number, offset: number): void;
+    /** Remove a chapter from the book and close the numbering gap. */
+    removeChapter(docId: number): void;
+    /** Append the documents selected in the file selector as new chapters. */
+    addChapters(fileSelector: FileSelector): void;
+    /** Handle a click anywhere inside the dialog. */
+    handleDialogClick(event: Event, fileSelector?: FileSelector): void;
+    /** Save the book and render its sanity check report in place. */
+    performSanityCheck(): Promise<void>;
+}
+//# sourceMappingURL=dialog.d.ts.map

package/dist/ui/book_dialog/dialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog.d.ts","sourceRoot":"","sources":["../../../src/ui/book_dialog/dialog.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAC,IAAI,EAAgB,OAAO,EAAC,MAAM,gBAAgB,CAAA;AAC/D,OAAO,EAEH,MAAM,EACN,YAAY,EAIf,MAAM,WAAW,CAAA;AAGlB,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,aAAa,CAAA;AAkB/C,OAAO,KAAK,EACR,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,cAAc,EACjB,MAAM,YAAY,CAAA;AA8BnB,8BAA8B;AAC9B,qBAAa,UAAU;IACnB,OAAO,EAAE,iBAAiB,CAAA;IAC1B,uEAAuE;IACvE,KAAK,EAAE,OAAO,CAAA;IACd,wEAAwE;IACxE,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAA;IAC/C,UAAU,EAAE,cAAc,CAAA;IAC1B,uDAAuD;IACvD,MAAM,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAA;IACzD,WAAW,EAAE,cAAc,EAAE,CAAA;IAC7B,mEAAmE;IACnE,WAAW,EAAE,iBAAiB,CAAA;IAC9B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB,YAAY,OAAO,EAAE,iBAAiB,EAuErC;IAED,iEAAiE;IACjE,OAAO,IAAI,iBAAiB,CAQ3B;IAED,sEAAsE;IACtE,IAAI,IAAI,UAAU,CAEjB;IAED,sDAAsD;IACtD,QAAQ,IAAI,cAAc,CAQzB;IAED,wEAAwE;IACxE,eAAe,IAAI,IAAI,CAoBtB;IAED;;;;;;;OAOG;IACH,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAI5B;IAED,kCAAkC;IAClC,IAAI,IAAI,IAAI,CAuKX;IAED,4DAA4D;IAC5D,QAAQ,IAAI,OAAO,CAElB;IAED;;;;;OAKG;IACH,iBAAiB,CACb,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,EACrD,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAClE,IAAI,CAuBN;IAED,sDAAsD;IACtD,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAK5C;IAED,kCAAkC;IAClC,kBAAkB,IAAI,IAAI,CAQzB;IAED;;;;OAIG;IACH,mBAAmB,IAAI,IAAI,CAwB1B;IAED,wDAAwD;IACxD,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAmCxC;IAED,yEAAyE;IACzE,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAmBhC;IAED;;;;;OAKG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAyC3B;IAED;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAc/C;IAED,kEAAkE;IAClE,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAiBjC;IAED,0EAA0E;IAC1E,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAiB5C;IAED,iDAAiD;IACjD,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAgFjE;IAED,iEAAiE;IACjE,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CAgBlC;CACJ"}