Skip to content

fix: improve type safety for additional source builders (#2170) #5586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mkcodes4 wants to merge 3 commits into
base: main
Choose a base branch
from
+10 −10
Open

fix: improve type safety for additional source builders (#2170) #5586

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32484be
fix: improve type safety for additional source builders (#2170)
mkcodes4 Jun 11, 2026
f1b4e81
fix: format with prettier
mkcodes4 Jun 11, 2026
844c786
fix: restore Pipfile.lock
mkcodes4 Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions frontend/shared/utils/get-additional-sources.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,16 +245,22 @@ const additionalSourceBuilders: AdditionalSourceBuilder[] = [
},
]

type SelectiveRequired<T, K extends keyof T> = { [P in K]-?: T[P] } & {
[P in keyof T]: T[P]
}

/**
* Get a list of source builders for a given media type.
*
* @param mediaType - the media type by which to filter source builders
* @returns a list of additional source builders
*/
export const getAdditionalSourceBuilders = (
mediaType: MediaType
): AdditionalSourceBuilder[] =>
additionalSourceBuilders.filter((source) => source[mediaType])
export const getAdditionalSourceBuilders = <T extends MediaType>(
mediaType: T
): SelectiveRequired<AdditionalSourceBuilder, T>[] =>
additionalSourceBuilders.filter(
(source) => source[mediaType]
) as SelectiveRequired<AdditionalSourceBuilder, T>[]

/**
* Get a list of sources for a given media type with the URL populated to show
Expand All @@ -270,12 +276,6 @@ export const getAdditionalSources = (
): AdditionalSource[] =>
getAdditionalSourceBuilders(mediaType).map((source) => {
const urlFunc = source[mediaType]
// type-guard, never occurs
if (!urlFunc) {
throw new Error(
`Invalid media type ${mediaType} for additional source ${source.name}`
)
}

const urlInfo = urlFunc(transformSearchQuery(query))
const sourceUrl = new URL(urlInfo.url)
Expand Down
Loading