Merge pull request #348 from Stremio/typings

Core Typings

src/common/index.js

@@ -27,8 +27,8 @@ const comparatorWithPriorities = require('./comparatorWithPriorities');
 const CONSTANTS = require('./CONSTANTS');
 const { withCoreSuspender, useCoreSuspender } = require('./CoreSuspender');
 const getVisibleChildrenRange = require('./getVisibleChildrenRange');
-const interfaceLanguages = require('./interfaceLanguages');
-const languageNames = require('./languageNames');
+const interfaceLanguages = require('./interfaceLanguages.json');
+const languageNames = require('./languageNames.json');
 const routesRegexp = require('./routesRegexp');
 const translateOption = require('./translateOption');
 const useAnimationFrame = require('./useAnimationFrame');

src/common/useProfile.d.ts

@@ -0,0 +1,2 @@
+declare const useProfile: () => Profile;
+export = useProfile;

src/common/useStreamingServer.d.ts

@@ -0,0 +1,2 @@
+declare const useStreamingServer: () => StreamingServer;
+export = useStreamingServer;

src/modules.d.ts

@@ -0,0 +1,2 @@
+declare module '*';
+declare module 'classnames';

src/routes/Addons/useInstalledAddons.d.ts

@@ -0,0 +1,2 @@
+declare const useInstalledAddons: (urlParams: UrlParams) => InstalledAddons;
+export = useInstalledAddons;

src/routes/Addons/useRemoteAddons.d.ts

@@ -0,0 +1,2 @@
+declare const useRemoteAddons: (urlParams: UrlParams) => RemoteAddons;
+export = useRemoteAddons;

src/routes/Board/useBoard.d.ts

@@ -0,0 +1,2 @@
+declare const useBoard: () => [Board, ({ start, end }: { start: number, end: number }) => void];
+export = useBoard;

src/routes/Discover/useDiscover.d.ts

@@ -0,0 +1,2 @@
+declare const useDiscover: (urlParams: UrlParams, searchParams: URLSearchParams) => [Discover, () => void];
+export = useDiscover;

src/routes/Library/useLibrary.d.ts

@@ -0,0 +1,2 @@
+declare const useLibrary: (model: string, urlParams: UrlParams, searchParams: URLSearchParams) => Library;
+export = useLibrary;

src/routes/MetaDetails/useMetaDetails.d.ts

@@ -0,0 +1,2 @@
+declare const useMetaDetails: (urlParams: UrlParams) => MetaDetails;
+export = useMetaDetails;

src/routes/Player/usePlayer.d.ts

@@ -0,0 +1,2 @@
+declare const usePlayer: (urlParams: UrlParams, videoParams: any) => [Player, (time: number, duration: number, device: string) => void, (paused: boolean) => void, () => void, () => void];
+export = usePlayer;

src/routes/Player/useSettings.d.ts

@@ -0,0 +1,2 @@
+declare const useSettings: () => [Settings, (settings: any) => void];
+export = useSettings;

src/routes/Search/useSearch.d.ts

@@ -0,0 +1,2 @@
+declare const useSearch: (searchParams: URLSearchParams) => [Search, (range: number) => void];
+export = useSearch;

src/services/Core/Core.d.ts

@@ -0,0 +1,2 @@
+declare function Core(): Core;
+export = Core;

src/services/Core/CoreTransport.d.ts

@@ -0,0 +1,2 @@
+declare function CoreTransport(): CoreTransport;
+export = CoreTransport;

src/services/Core/globals.d.ts

@@ -0,0 +1,12 @@
+type CoreEvent = {
+    name: string,
+    args: any[],
+};
+
+declare global {
+    interface Window {
+        onCoreEvent: (event: CoreEvent) => void;
+    }
+}
+
+export {};

src/services/Core/types.d.ts

@@ -0,0 +1,28 @@
+type Action = {
+    action: string,
+    args?: {
+        model?: string,
+        action?: string,
+        args?: any,
+    }
+};
+
+type AnalyticsEvent = {
+    event: string,
+    args: object,
+};
+
+interface CoreTransport {
+    start: (args: object) => Promise<void>,
+    getState: (model: string) => Promise<object>,
+    dispatch: (action: Action, model?: string) => Promise<void>,
+    decodeStream: (stream: string) => Promise<Stream>,
+    analytics: (event: AnalyticsEvent) => Promise<void>,
+    on: (name: string, listener: () => void) => void,
+    off: (name: string, listener: () => void) => void,
+}
+
+interface Core {
+    active: boolean,
+    transport: CoreTransport,
+}

src/services/ServicesContext/types.d.ts

@@ -0,0 +1,7 @@
+type ServicesContext = {
+    core: Core,
+    shell: any,
+    chromecast: any,
+    keyboardShortcuts: any,
+    dragAndDrop: any,
+};

src/services/ServicesContext/useServices.d.ts

@@ -0,0 +1,2 @@
+declare const useService: () => ServicesContext;
+export = useService;

src/types/Addon.d.ts

@@ -0,0 +1,20 @@
+type AddonManifest = {
+    id: string,
+    version: string,
+    name: string,
+    description: string,
+    contactEmail: string,
+    logo: string,
+    background: string,
+    types: string[],
+};
+
+type Addon = {
+    installed: boolean,
+    manifest: AddonManifest,
+    transportUrl: string,
+};
+
+type AddonsDeepLinks = {
+    addons: string,
+};

src/types/LibraryItem.d.ts

@@ -0,0 +1,34 @@
+type LibraryItemState = {
+    lastWatched: string,
+    timeWatched: number,
+    timesWatched: number,
+    flaggedWatched: number,
+    overallTimeWatched: number,
+    timeOffset: number,
+    duration: number,
+    video_id: string,
+    watched: string,
+    lastVidReleased: string,
+    noNotif: boolean,
+};
+
+type LibraryItem = {
+    _id: string,
+    name: string,
+    type: string,
+    poster: string,
+    posterShape: PosterShape,
+    removed: number,
+    temp: number,
+    _ctime: string,
+    _mtime: number,
+    state: LibraryItemState,
+    behaviorHints: BehaviorHints,
+};
+
+type LibraryItemDeepLinks = {
+    metaDetailsVideos: string | null,
+    metaDetailsStreams: string | null,
+    player: string | null,
+    externalPlayer: ExternalPlayerLinks | null,
+};

src/types/MetaItem.d.ts

@@ -0,0 +1,32 @@
+type Link = {
+    name: string,
+    category: string,
+    url: string,
+};
+
+type MetaItemPreview = {
+    id: string,
+    type: string,
+    name: string,
+    description: string | null,
+    logo: string | null,
+    background: string | null,
+    poster: string | null,
+    posterShape: PosterShape,
+    releaseInfo: string | null,
+    runtime: string | null,
+    released: string | null,
+    trailerStreams: TrailerStream[],
+    links: Link[],
+    behaviorHints: BehaviorHints,
+};
+
+type MetaItem = MetaItemPreview & {
+    videos: Video[],
+}
+
+type MetaItemDeepLinks = {
+    metaDetailsVideos: string | null,
+    metaDetailsStreams: string | null,
+    player: string | null,
+};

src/types/Selectable.d.ts

@@ -0,0 +1,27 @@
+type SelectableType<T> = {
+    type: string,
+    selected: boolean,
+    deepLinks: T
+};
+
+type SelectableSort<T> = {
+    sort: string,
+    selected: boolean,
+    deepLinks: T
+};
+
+type SelectableExtra<T> = {
+    isRequired: boolean,
+    name: string,
+    options: {
+        deepLinks: T,
+        selected: boolean,
+        value: string | null,
+    }
+};
+
+type SelectableCatalog<T> = {
+    name: string,
+    selected: boolean,
+    deepLinks: T,
+};

src/types/Stream.d.ts

@@ -0,0 +1,18 @@
+
+type StreamDeepLinks = {
+    player: string | null,
+    externalPlayer: ExternalPlayerLinks,
+};
+
+type Stream = {
+    ytId?: string,
+    name: string,
+    description: string,
+    infoHash?: string,
+    fileIdx?: string,
+    externalUrl?: string,
+    deepLinks: {
+        player: string,
+        externalPlayer: ExternalPlayerLinks,
+    },
+};

src/types/Video.d.ts

@@ -0,0 +1,17 @@
+type VideoDeepLinks = {
+    metaDetailsStreams: string,
+    player: string | null,
+    externalPlayer: ExternalPlayerLinks | null,
+};
+
+type Video = {
+    id: string,
+    title: string,
+    overview: string | null,
+    released: string | null,
+    thumbnail: string | null,
+    season?: number,
+    episode?: number,
+    streams: Stream[],
+    trailerStreams: TrailerStream[],
+};

src/types/models/Board.d.ts

@@ -0,0 +1 @@
+type Board = CatalogsWithExtra;

src/types/models/CatalogsWithExtra.d.ts

@@ -0,0 +1,11 @@
+type MetaItemPreviewCatalogsWithExtra = MetaItemPreview & {
+    deepLinks: MetaItemDeepLinks,
+};
+
+type CatalogsWithExtra = {
+    catalogs: Catalog<Loadable<MetaItemPreviewCatalogsWithExtra[]>, DiscoverDeepLinks>[] | null,
+    selected: {
+        type: string | null,
+        extra: [string, string][]
+    } | null,
+};

src/types/models/Ctx.d.ts

@@ -0,0 +1,47 @@
+type Auth = {
+    key: string,
+    user: {
+        _id: string,
+        avatar: string,
+        email: string,
+        trakt: {
+            access_token: string,
+            created_at: number,
+            expires_in: number,
+        },
+    },
+};
+
+type Settings = {
+    audioLanguage: string,
+    audioPassthrough: boolean,
+    autoFrameRateMatching: boolean,
+    bingeWatching: boolean,
+    hardwareDecoding: boolean,
+    interfaceLanguage: string,
+    nextVideoNotificationDuration: number,
+    playInBackground: boolean,
+    playerType: string | null,
+    secondaryAudioLanguage: string | null,
+    secondarySubtitlesLanguage: string | null,
+    seekTimeDuration: number,
+    streamingServerUrl: string,
+    streamingServerWarningDismissed: Date | null,
+    subtitlesBackgroundColor: string,
+    subtitlesBold: boolean,
+    subtitlesFont: string,
+    subtitlesLanguage: string,
+    subtitlesOffset: number,
+    subtitlesOutlineColor: string,
+    subtitlesSize: number,
+    subtitlesTextColor: string,
+};
+
+type Profile = {
+    auth: Auth | null,
+    settings: Settings,
+};
+
+type Ctx = {
+    profile: Profile,
+};

src/types/models/Discover.d.ts

@@ -0,0 +1,26 @@
+type DiscoverDeepLinks = {
+    discover: string,
+};
+
+type MetaItemPreviewDiscover = MetaItemPreview & {
+    inLibrary: boolean,
+    deepLinks: MetaItemDeepLinks,
+};
+
+type DiscoverCatalogOption<T> = SelectableCatalog<T> & {
+    id: string,
+    addon: Addon,
+};
+
+type Discover = {
+    catalog: Catalog<Loadable<MetaItemPreviewDiscover[]>> | null,
+    selectable: {
+        catalogs: DiscoverCatalogOption<DiscoverDeepLinks>,
+        extra: SelectableExtra<DiscoverDeepLinks>[],
+        types: SelectableType<DiscoverDeepLinks>[],
+        nextPage: boolean,
+    },
+    selected: {
+        request: ResourceRequest,
+    } | null,
+};

src/types/models/InstalledAddons.d.ts

@@ -0,0 +1,12 @@
+type InstalledAddons = {
+    catalog: Addon[],
+    selectable: {
+        catalogs: SelectableCatalog<AddonsDeepLinks>[],
+        types: SelectableType<AddonsDeepLinks>[],
+    },
+    selected: {
+        request: {
+            type: string,
+        }
+    } | null,
+};