diff options
Diffstat (limited to 'packages/models/src/search')
7 files changed, 122 insertions, 0 deletions
diff --git a/packages/models/src/search/boolean-both-query.model.ts b/packages/models/src/search/boolean-both-query.model.ts new file mode 100644 index 000000000..d6a438249 --- /dev/null +++ b/packages/models/src/search/boolean-both-query.model.ts | |||
@@ -0,0 +1,2 @@ | |||
1 | export type BooleanBothQuery = 'true' | 'false' | 'both' | ||
2 | export type BooleanQuery = 'true' | 'false' | ||
diff --git a/packages/models/src/search/index.ts b/packages/models/src/search/index.ts new file mode 100644 index 000000000..5c4de1eea --- /dev/null +++ b/packages/models/src/search/index.ts | |||
@@ -0,0 +1,6 @@ | |||
1 | export * from './boolean-both-query.model.js' | ||
2 | export * from './search-target-query.model.js' | ||
3 | export * from './videos-common-query.model.js' | ||
4 | export * from './video-channels-search-query.model.js' | ||
5 | export * from './video-playlists-search-query.model.js' | ||
6 | export * from './videos-search-query.model.js' | ||
diff --git a/packages/models/src/search/search-target-query.model.ts b/packages/models/src/search/search-target-query.model.ts new file mode 100644 index 000000000..3bb2e0d31 --- /dev/null +++ b/packages/models/src/search/search-target-query.model.ts | |||
@@ -0,0 +1,5 @@ | |||
1 | export type SearchTargetType = 'local' | 'search-index' | ||
2 | |||
3 | export interface SearchTargetQuery { | ||
4 | searchTarget?: SearchTargetType | ||
5 | } | ||
diff --git a/packages/models/src/search/video-channels-search-query.model.ts b/packages/models/src/search/video-channels-search-query.model.ts new file mode 100644 index 000000000..7e84359cf --- /dev/null +++ b/packages/models/src/search/video-channels-search-query.model.ts | |||
@@ -0,0 +1,18 @@ | |||
1 | import { SearchTargetQuery } from './search-target-query.model.js' | ||
2 | |||
3 | export interface VideoChannelsSearchQuery extends SearchTargetQuery { | ||
4 | search?: string | ||
5 | |||
6 | start?: number | ||
7 | count?: number | ||
8 | sort?: string | ||
9 | |||
10 | host?: string | ||
11 | handles?: string[] | ||
12 | } | ||
13 | |||
14 | export interface VideoChannelsSearchQueryAfterSanitize extends VideoChannelsSearchQuery { | ||
15 | start: number | ||
16 | count: number | ||
17 | sort: string | ||
18 | } | ||
diff --git a/packages/models/src/search/video-playlists-search-query.model.ts b/packages/models/src/search/video-playlists-search-query.model.ts new file mode 100644 index 000000000..65ac7b4d7 --- /dev/null +++ b/packages/models/src/search/video-playlists-search-query.model.ts | |||
@@ -0,0 +1,20 @@ | |||
1 | import { SearchTargetQuery } from './search-target-query.model.js' | ||
2 | |||
3 | export interface VideoPlaylistsSearchQuery extends SearchTargetQuery { | ||
4 | search?: string | ||
5 | |||
6 | start?: number | ||
7 | count?: number | ||
8 | sort?: string | ||
9 | |||
10 | host?: string | ||
11 | |||
12 | // UUIDs or short UUIDs | ||
13 | uuids?: string[] | ||
14 | } | ||
15 | |||
16 | export interface VideoPlaylistsSearchQueryAfterSanitize extends VideoPlaylistsSearchQuery { | ||
17 | start: number | ||
18 | count: number | ||
19 | sort: string | ||
20 | } | ||
diff --git a/packages/models/src/search/videos-common-query.model.ts b/packages/models/src/search/videos-common-query.model.ts new file mode 100644 index 000000000..45181a739 --- /dev/null +++ b/packages/models/src/search/videos-common-query.model.ts | |||
@@ -0,0 +1,45 @@ | |||
1 | import { VideoIncludeType } from '../videos/video-include.enum.js' | ||
2 | import { VideoPrivacyType } from '../videos/video-privacy.enum.js' | ||
3 | import { BooleanBothQuery } from './boolean-both-query.model.js' | ||
4 | |||
5 | // These query parameters can be used with any endpoint that list videos | ||
6 | export interface VideosCommonQuery { | ||
7 | start?: number | ||
8 | count?: number | ||
9 | sort?: string | ||
10 | |||
11 | nsfw?: BooleanBothQuery | ||
12 | |||
13 | isLive?: boolean | ||
14 | |||
15 | isLocal?: boolean | ||
16 | include?: VideoIncludeType | ||
17 | |||
18 | categoryOneOf?: number[] | ||
19 | |||
20 | licenceOneOf?: number[] | ||
21 | |||
22 | languageOneOf?: string[] | ||
23 | |||
24 | privacyOneOf?: VideoPrivacyType[] | ||
25 | |||
26 | tagsOneOf?: string[] | ||
27 | tagsAllOf?: string[] | ||
28 | |||
29 | hasHLSFiles?: boolean | ||
30 | |||
31 | hasWebtorrentFiles?: boolean // TODO: remove in v7 | ||
32 | hasWebVideoFiles?: boolean | ||
33 | |||
34 | skipCount?: boolean | ||
35 | |||
36 | search?: string | ||
37 | |||
38 | excludeAlreadyWatched?: boolean | ||
39 | } | ||
40 | |||
41 | export interface VideosCommonQueryAfterSanitize extends VideosCommonQuery { | ||
42 | start: number | ||
43 | count: number | ||
44 | sort: string | ||
45 | } | ||
diff --git a/packages/models/src/search/videos-search-query.model.ts b/packages/models/src/search/videos-search-query.model.ts new file mode 100644 index 000000000..bbaa8d23f --- /dev/null +++ b/packages/models/src/search/videos-search-query.model.ts | |||
@@ -0,0 +1,26 @@ | |||
1 | import { SearchTargetQuery } from './search-target-query.model.js' | ||
2 | import { VideosCommonQuery } from './videos-common-query.model.js' | ||
3 | |||
4 | export interface VideosSearchQuery extends SearchTargetQuery, VideosCommonQuery { | ||
5 | search?: string | ||
6 | |||
7 | host?: string | ||
8 | |||
9 | startDate?: string // ISO 8601 | ||
10 | endDate?: string // ISO 8601 | ||
11 | |||
12 | originallyPublishedStartDate?: string // ISO 8601 | ||
13 | originallyPublishedEndDate?: string // ISO 8601 | ||
14 | |||
15 | durationMin?: number // seconds | ||
16 | durationMax?: number // seconds | ||
17 | |||
18 | // UUIDs or short UUIDs | ||
19 | uuids?: string[] | ||
20 | } | ||
21 | |||
22 | export interface VideosSearchQueryAfterSanitize extends VideosSearchQuery { | ||
23 | start: number | ||
24 | count: number | ||
25 | sort: string | ||
26 | } | ||