@segnavia/format 0.10.0 → 0.11.0

package/dist/board-geometry.d.ts

@@ -27,6 +27,7 @@ export declare function boardBounds(board: Board, shapes: BoardShapes): Box;
 export declare function boardToScreen(view: BoardView, point: Point): Point;
 export declare function screenToBoard(view: BoardView, point: Point): Point;
 export declare function zoomToFit(bounds: Box, viewport: Size, padding: number): BoardView;
+export declare function revealView(bounds: Box, viewport: Size, padding: number, options?: ZoomBounds): BoardView;
 export declare function zoomAt(view: BoardView, point: Point, factor: number, options?: ZoomBounds): BoardView;
 export declare function visibleItems(board: Board, shapes: BoardShapes, view: BoardView, margin: number): BoardItem[];
 export declare function itemAt(board: Board, shapes: BoardShapes, point: Point): BoardItem | undefined;

package/dist/board-geometry.js

@@ -83,6 +83,21 @@ function zoomToFit(bounds, viewport, padding) {
 		viewport
 	};
 }
+function revealView(bounds, viewport, padding, options = {}) {
+	const fitted = zoomToFit(bounds, viewport, padding);
+	const minZoom = options.minZoom ?? .05;
+	const maxZoom = options.maxZoom ?? 8;
+	if (!(minZoom > 0 && maxZoom >= minZoom)) throw new Error("zoom bounds are invalid; provide a positive minZoom no greater than maxZoom");
+	const zoom = Math.min(maxZoom, Math.max(minZoom, fitted.zoom));
+	return {
+		zoom,
+		pan: {
+			x: viewport.width / 2 - (bounds.x + bounds.width / 2) * zoom,
+			y: viewport.height / 2 - (bounds.y + bounds.height / 2) * zoom
+		},
+		viewport
+	};
+}
 function zoomAt(view, point, factor, options = {}) {
 	requireView(view);
 	if (!(factor > 0)) throw new Error(`zoom factor is ${factor}; provide a factor greater than zero`);
@@ -181,4 +196,4 @@ function arrange(board, shapes, options) {
 	};
 }
 //#endregion
-export { MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, arrange, boardBounds, boardToScreen, itemAt, itemHeight, screenToBoard, visibleItems, zoomAt, zoomToFit };
+export { MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, arrange, boardBounds, boardToScreen, itemAt, itemHeight, revealView, screenToBoard, visibleItems, zoomAt, zoomToFit };

package/dist/board-listing.d.ts

@@ -0,0 +1,15 @@
+import { Board, BoardItem, BoardSection } from "./board.js";
+//#region src/board-listing.d.ts
+export type BoardListingGroup = {
+  kind: 'section';
+  section: BoardSection;
+  items: BoardItem[];
+} | {
+  kind: 'loose';
+  items: BoardItem[];
+};
+export declare function foldForSearch(text: string): string;
+export declare function nameMatches(name: string, query: string): boolean;
+export declare function boardListingIsEmpty(query: string, groups: BoardListingGroup[]): boolean;
+export declare function boardListing(board: Board, nameOf: (item: BoardItem) => string, query: string, contentMatches?: Iterable<string>): BoardListingGroup[];
+//#endregion

package/dist/board-listing.js

@@ -0,0 +1,47 @@
+//#region src/board-listing.ts
+const FINAL_LETTERS = {
+	ך: "כ",
+	ם: "מ",
+	ן: "נ",
+	ף: "פ",
+	ץ: "צ"
+};
+function foldForSearch(text) {
+	return text.normalize("NFD").replace(/\p{M}/gu, "").replace(/[ךםןףץ]/g, (letter) => FINAL_LETTERS[letter] ?? letter).toLowerCase().trim().replace(/\s+/g, " ");
+}
+function nameMatches(name, query) {
+	return foldForSearch(name).includes(foldForSearch(query));
+}
+function boardListingIsEmpty(query, groups) {
+	return foldForSearch(query).length > 0 && groups.length === 0;
+}
+function boardListing(board, nameOf, query, contentMatches = []) {
+	const folded = foldForSearch(query);
+	const byId = new Map(board.items.map((item) => [item.id, item]));
+	const content = new Set(contentMatches);
+	const claimed = /* @__PURE__ */ new Set();
+	const groups = [];
+	for (const section of board.sections) {
+		const members = section.items.flatMap((id) => {
+			if (claimed.has(id)) return [];
+			claimed.add(id);
+			const item = byId.get(id);
+			return item ? [item] : [];
+		});
+		const items = !folded || nameMatches(section.title, folded) ? members : members.filter((item) => nameMatches(nameOf(item), folded) || content.has(item.id));
+		if (!folded || items.length > 0) groups.push({
+			kind: "section",
+			section,
+			items
+		});
+	}
+	const loose = board.items.filter((item) => !claimed.has(item.id));
+	const visibleLoose = folded ? loose.filter((item) => nameMatches(nameOf(item), folded) || content.has(item.id)) : loose;
+	if (visibleLoose.length > 0) groups.push({
+		kind: "loose",
+		items: visibleLoose
+	});
+	return groups;
+}
+//#endregion
+export { boardListing, boardListingIsEmpty, foldForSearch, nameMatches };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { Board, BoardInput, BoardItem, BoardLabel, BoardSection } from "./board.js";
 import { Annotation, Box, Cue, DECK_SIZE, Deck, DeckInput, DeckLimits, ImageFit, Manifest, Narration, Point, PublishedShot, SHOT_KEY, Shot, Size, Slide, SlideContent, Word, annotationCueIssues, exceedsLimits } from "./deck.js";
-import { ArrangeOptions, BoardShapes, BoardView, MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, ZoomBounds, arrange, boardBounds, boardToScreen, itemAt, itemHeight, screenToBoard, visibleItems, zoomAt, zoomToFit } from "./board-geometry.js";
+import { ArrangeOptions, BoardShapes, BoardView, MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, ZoomBounds, arrange, boardBounds, boardToScreen, itemAt, itemHeight, revealView, screenToBoard, visibleItems, zoomAt, zoomToFit } from "./board-geometry.js";
+import { BoardListingGroup, boardListing, boardListingIsEmpty, foldForSearch, nameMatches } from "./board-listing.js";
 import { Book, BookContents, BookFrontMatterEntry, BookInput, BookMode, BookPage, BookSection, BookView, BookViewInput, Chapter, isBookContents, isHebrew, noteMarkerIssues } from "./book.js";
 import { DeckFromSlidesOptions, SlideRow, deckFromSlides } from "./deck-from-slides.js";
 import { Direction, TextDirection, firstStrongDirection, languageDirection, resolveDirection } from "./direction.js";
@@ -719,4 +720,4 @@ export declare function jsonSchemas(): {
   }, z.core.$strip>>;
 };
 //#endregion
-export { Annotation, type ArrangeOptions, Board, type BoardInput, BoardItem, BoardLabel, BoardSection, type BoardShapes, type BoardView, Book, BookContents, BookFrontMatterEntry, type BookInput, BookMode, BookPage, BookSection, BookView, type BookViewInput, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, type DeckFromSlidesOptions, type DeckInput, type DeckLimits, Direction, ImageFit, type Imposed, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, type MillimeterEdges, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, Paper, type PaperBox, type Placement, Point, PronunciationEntry, PublishedShot, SHOT_KEY, Scripts, Shot, type ShotUse, Size, Slide, SlideContent, type SlideRow, TextDirection, Transition, TransitionInput, Word, type ZoomBounds, annotationCueIssues, arrange, boardBounds, boardToScreen, deckFromSlides, exceedsLimits, firstStrongDirection, fitPage, formatNumber, impose, isBookContents, isHebrew, itemAt, itemHeight, languageDirection, lexiconVersion, mirrorPlacement, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, screenToBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };
+export { Annotation, type ArrangeOptions, Board, type BoardInput, BoardItem, BoardLabel, type BoardListingGroup, BoardSection, type BoardShapes, type BoardView, Book, BookContents, BookFrontMatterEntry, type BookInput, BookMode, BookPage, BookSection, BookView, type BookViewInput, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, type DeckFromSlidesOptions, type DeckInput, type DeckLimits, Direction, ImageFit, type Imposed, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, type MillimeterEdges, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, type PageFit, type PagePlacementKind, type PagePlacementLayout, Paper, type PaperBox, type Placement, Point, PronunciationEntry, PublishedShot, SHOT_KEY, Scripts, Shot, type ShotUse, Size, Slide, SlideContent, type SlideRow, TextDirection, Transition, TransitionInput, Word, type ZoomBounds, annotationCueIssues, arrange, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, exceedsLimits, firstStrongDirection, fitPage, foldForSearch, formatNumber, impose, isBookContents, isHebrew, itemAt, itemHeight, languageDirection, lexiconVersion, mirrorPlacement, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, revealView, roundMillimeters, screenToBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };

package/dist/index.js

@@ -8,7 +8,8 @@ import { NoteMarker, NumberSystem, formatNumber, noteMarker } from "./numbering.
 import { MARK_GAP_MM, MARK_LENGTH_MM, MM_PER_PT, NAMED_PAPERS, PAPER_MM, PX_PER_MM, Paper, printBoxes, printPadding, printProperties, roundMillimeters, sheetMm, toMillimeters } from "./paper.js";
 import { Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookShape, BookView, Chapter, isBookContents, isHebrew, noteMarkerIssues } from "./book.js";
 import { Lexicon, PronunciationEntry, lexiconVersion } from "./lexicon.js";
-import { MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, arrange, boardBounds, boardToScreen, itemAt, itemHeight, screenToBoard, visibleItems, zoomAt, zoomToFit } from "./board-geometry.js";
+import { MAX_BOARD_ZOOM, MIN_BOARD_ZOOM, arrange, boardBounds, boardToScreen, itemAt, itemHeight, revealView, screenToBoard, visibleItems, zoomAt, zoomToFit } from "./board-geometry.js";
+import { boardListing, boardListingIsEmpty, foldForSearch, nameMatches } from "./board-listing.js";
 import { deckFromSlides } from "./deck-from-slides.js";
 import { fitPage, impose, mirrorPlacement, pagePlacementLayout } from "./imposition.js";
 import { shotsUsed } from "./shots-used.js";
@@ -154,4 +155,4 @@ function jsonSchemas() {
 	};
 }
 //#endregion
-export { Annotation, Board, BoardItem, BoardLabel, BoardSection, Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookView, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, ImageFit, Imposition, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, Page, PageSize, Paper, Point, Print, PronunciationEntry, PublishedShot, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, TextDirection, Transition, Word, annotationCueIssues, arrange, boardBounds, boardToScreen, deckFromSlides, exceedsLimits, firstStrongDirection, fitPage, formatNumber, impose, isBookContents, isHebrew, itemAt, itemHeight, jsonSchemas, languageDirection, lexiconVersion, mirrorPlacement, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, roundMillimeters, screenToBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };
+export { Annotation, Board, BoardItem, BoardLabel, BoardSection, Book, BookContents, BookFrontMatterEntry, BookMode, BookPage, BookSection, BookView, Box, Chapter, Cue, DECK_SIZE, DEFAULT_TRANSITION_DURATION_MS, Deck, Direction, ImageFit, Imposition, Lexicon, MARK_GAP_MM, MARK_LENGTH_MM, MAX_BOARD_ZOOM, MAX_IMPOSITION_CELLS, MAX_SLIDE_TIMING_MS, MAX_TRANSITION_DURATION_MS, MIN_BOARD_ZOOM, MIN_TRANSITION_DURATION_MS, MM_PER_PT, Manifest, Margin, NAMED_PAPERS, Narration, NoteMarker, NumberSystem, PAPER_MM, PX_PER_MM, Page, PageSize, Paper, Point, Print, PronunciationEntry, PublishedShot, SHOT_KEY, Scripts, Shot, Size, Slide, SlideContent, TextDirection, Transition, Word, annotationCueIssues, arrange, boardBounds, boardListing, boardListingIsEmpty, boardToScreen, deckFromSlides, exceedsLimits, firstStrongDirection, fitPage, foldForSearch, formatNumber, impose, isBookContents, isHebrew, itemAt, itemHeight, jsonSchemas, languageDirection, lexiconVersion, mirrorPlacement, nameMatches, noteMarker, noteMarkerIssues, pagePlacementLayout, printBoxes, printPadding, printProperties, resolveDirection, revealView, roundMillimeters, screenToBoard, sheetMm, shotsUsed, toMillimeters, visibleItems, zoomAt, zoomToFit };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@segnavia/format",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "type": "module",
   "license": "MIT",
   "repository": {