diff options
author | Chocobozzz <me@florianbigard.com> | 2023-07-31 14:34:36 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2023-08-11 15:02:33 +0200 |
commit | 3a4992633ee62d5edfbb484d9c6bcb3cf158489d (patch) | |
tree | e4510b39bdac9c318fdb4b47018d08f15368b8f0 /packages/models/src/search | |
parent | 04d1da5621d25d59bd5fa1543b725c497bf5d9a8 (diff) | |
download | PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.gz PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.tar.zst PeerTube-3a4992633ee62d5edfbb484d9c6bcb3cf158489d.zip |
Migrate server to ESM
Sorry for the very big commit that may lead to git log issues and merge
conflicts, but it's a major step forward:
* Server can be faster at startup because imports() are async and we can
easily lazy import big modules
* Angular doesn't seem to support ES import (with .js extension), so we
had to correctly organize peertube into a monorepo:
* Use yarn workspace feature
* Use typescript reference projects for dependencies
* Shared projects have been moved into "packages", each one is now a
node module (with a dedicated package.json/tsconfig.json)
* server/tools have been moved into apps/ and is now a dedicated app
bundled and published on NPM so users don't have to build peertube
cli tools manually
* server/tests have been moved into packages/ so we don't compile
them every time we want to run the server
* Use isolatedModule option:
* Had to move from const enum to const
(https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums)
* Had to explictely specify "type" imports when used in decorators
* Prefer tsx (that uses esbuild under the hood) instead of ts-node to
load typescript files (tests with mocha or scripts):
* To reduce test complexity as esbuild doesn't support decorator
metadata, we only test server files that do not import server
models
* We still build tests files into js files for a faster CI
* Remove unmaintained peertube CLI import script
* Removed some barrels to speed up execution (less imports)
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 | } | ||