Skip to main content

Interface: ICollectionRepository

Defined in: Data/Repositories/ICollectionRepository.ts:7

Repository interface for managing Collections and Pinned Items Collections are user-created organizational containers (like bookmarks/folders)

Methods​

addPinnedItem()​

addPinnedItem(item): number

Defined in: Data/Repositories/ICollectionRepository.ts:59

Add a pinned item to a collection

Parameters​

item​

PinnedItem

Returns​

number

The ID of the newly created pinned item

create()​

create(collection): number

Defined in: Data/Repositories/ICollectionRepository.ts:14

Create a new collection

Parameters​

collection​

Collection

Returns​

number

The ID of the newly created collection

delete()​

delete(collectionId): void

Defined in: Data/Repositories/ICollectionRepository.ts:25

Delete a collection and all its pinned items (CASCADE delete from database)

Parameters​

collectionId​

number

Returns​

void

deletePinnedItem()​

deletePinnedItem(pinId): void

Defined in: Data/Repositories/ICollectionRepository.ts:69

Delete a pinned item

Parameters​

pinId​

number

Returns​

void

findCollectionsByName()​

findCollectionsByName(searchTerm): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:93

Find collections by name (case-insensitive search)

Parameters​

searchTerm​

string

Returns​

Collection[]

getAll()​

getAll(): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:35

Get all collections (flat list)

Returns​

Collection[]

getById()​

getById(collectionId): Collection | undefined

Defined in: Data/Repositories/ICollectionRepository.ts:30

Get a collection by ID

Parameters​

collectionId​

number

Returns​

Collection | undefined

getChildren()​

getChildren(parentId): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:45

Get child collections of a parent

Parameters​

parentId​

number

Returns​

Collection[]

getCollectionItemCount()​

getCollectionItemCount(collectionId): number

Defined in: Data/Repositories/ICollectionRepository.ts:109

Get the total count of pinned items in a collection

Parameters​

collectionId​

number

Returns​

number

getCollectionsContainingVerse()​

getCollectionsContainingVerse(verseId): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:99

Get all collections that contain a specific verse

Parameters​

verseId​

number

Returns​

Collection[]

Collections that have a pinned item referencing this verse

getCollectionTree()​

getCollectionTree(): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:51

Get a hierarchical tree of all collections (Collections with child collections populated)

Returns​

Collection[]

getPinnedItem()​

getPinnedItem(pinId): PinnedItem | undefined

Defined in: Data/Repositories/ICollectionRepository.ts:74

Get a single pinned item by ID

Parameters​

pinId​

number

Returns​

PinnedItem | undefined

getPinnedItemsByVerse()​

getPinnedItemsByVerse(verseId): PinnedItem[]

Defined in: Data/Repositories/ICollectionRepository.ts:86

Get all pinned items that reference a specific verse (Useful for checking if a verse is bookmarked)

Parameters​

verseId​

number

Returns​

PinnedItem[]

getPinnedItemsForCollection()​

getPinnedItemsForCollection(collectionId): PinnedItem[]

Defined in: Data/Repositories/ICollectionRepository.ts:80

Get all pinned items for a specific collection

Parameters​

collectionId​

number

Returns​

PinnedItem[]

Pinned items sorted by sort_order

getTopLevel()​

getTopLevel(): Collection[]

Defined in: Data/Repositories/ICollectionRepository.ts:40

Get only top-level collections (parent_collection_id IS NULL)

Returns​

Collection[]

isVerseBookmarked()​

isVerseBookmarked(verseId): boolean

Defined in: Data/Repositories/ICollectionRepository.ts:104

Check if a verse is pinned in any collection

Parameters​

verseId​

number

Returns​

boolean

moveCollection()​

moveCollection(collectionId, newParentId): void

Defined in: Data/Repositories/ICollectionRepository.ts:118

Move a collection to a different parent

Parameters​

collectionId​

number

The collection to move

newParentId​

number | null

The new parent (null for top-level)

Returns​

void

reorderCollections()​

reorderCollections(collectionIds): void

Defined in: Data/Repositories/ICollectionRepository.ts:124

Reorder collections within the same parent

Parameters​

collectionIds​

number[]

Array of collection IDs in desired order

Returns​

void

reorderPinnedItems()​

reorderPinnedItems(pinIds): void

Defined in: Data/Repositories/ICollectionRepository.ts:130

Reorder pinned items within a collection

Parameters​

pinIds​

number[]

Array of pin IDs in desired order

Returns​

void

update()​

update(collection): void

Defined in: Data/Repositories/ICollectionRepository.ts:19

Update an existing collection

Parameters​

collection​

Collection

Returns​

void

updatePinnedItem()​

updatePinnedItem(item): void

Defined in: Data/Repositories/ICollectionRepository.ts:64

Update an existing pinned item

Parameters​

item​

PinnedItem

Returns​

void