Merge pull request #4777 from thornbill/migrate-quick-connect

Migrate quick connect page to react

src/apps/experimental/App.tsx

@@ -9,6 +9,8 @@ import { toViewManagerPageRoute } from 'components/router/LegacyRoute';
 import AppLayout from './AppLayout';
 import { ASYNC_ADMIN_ROUTES, ASYNC_USER_ROUTES } from './routes/asyncRoutes';
 import { LEGACY_ADMIN_ROUTES, LEGACY_PUBLIC_ROUTES, LEGACY_USER_ROUTES } from './routes/legacyRoutes';
+import { REDIRECTS } from 'apps/stable/routes/_redirects';
+import { toRedirectRoute } from 'components/router/Redirect';
 
 const ExperimentalApp = () => {
     return (
@@ -38,7 +40,7 @@ const ExperimentalApp = () => {
                 </Route>
 
                 {/* Redirects for old paths */}
-                <Route path='serveractivity.html' element={<Navigate replace to='/dashboard/activity' />} />
+                {REDIRECTS.map(toRedirectRoute)}
             </Route>
         </Routes>
     );

src/apps/experimental/components/AppToolbar/menus/AppUserMenu.tsx

@@ -140,7 +140,7 @@ const AppUserMenu: FC<AppUserMenuProps> = ({
             <Divider />
             <MenuItem
                 component={Link}
-                to='/mypreferencesquickconnect.html'
+                to='/quickconnect'
                 onClick={onMenuClose}
             >
                 <ListItemIcon>

src/apps/experimental/routes/asyncRoutes/user.ts

@@ -1,6 +1,7 @@
 import { AsyncRoute, AsyncRouteType } from '../../../../components/router/AsyncRoute';
 
 export const ASYNC_USER_ROUTES: AsyncRoute[] = [
+    { path: 'quickconnect', page: 'quickConnect' },
     { path: 'search.html', page: 'search' },
     { path: 'userprofile.html', page: 'user/userprofile' },
     { path: 'home.html', page: 'home', type: AsyncRouteType.Experimental },

src/apps/experimental/routes/legacyRoutes/user.ts

@@ -49,12 +49,6 @@ export const LEGACY_USER_ROUTES: LegacyRoute[] = [
             controller: 'user/home/index',
             view: 'user/home/index.html'
         }
-    }, {
-        path: 'mypreferencesquickconnect.html',
-        pageProps: {
-            controller: 'user/quickConnect/index',
-            view: 'user/quickConnect/index.html'
-        }
     }, {
         path: 'mypreferencesplayback.html',
         pageProps: {

src/apps/stable/App.tsx

@@ -10,6 +10,8 @@ import { toViewManagerPageRoute } from 'components/router/LegacyRoute';
 
 import { ASYNC_ADMIN_ROUTES, ASYNC_USER_ROUTES } from './routes/asyncRoutes';
 import { LEGACY_ADMIN_ROUTES, LEGACY_PUBLIC_ROUTES, LEGACY_USER_ROUTES } from './routes/legacyRoutes';
+import { REDIRECTS } from './routes/_redirects';
+import { toRedirectRoute } from 'components/router/Redirect';
 
 const Layout = () => (
     <>
@@ -53,7 +55,7 @@ const StableApp = () => (
             <Route path='*' element={null} />
 
             {/* Redirects for old paths */}
-            <Route path='/serveractivity.html' element={<Navigate replace to='/dashboard/activity' />} />
+            {REDIRECTS.map(toRedirectRoute)}
         </Route>
     </Routes>
 );

src/apps/stable/routes/_redirects.ts

@@ -0,0 +1,6 @@
+import type { Redirect } from 'components/router/Redirect';
+
+export const REDIRECTS: Redirect[] = [
+    { from: 'mypreferencesquickconnect.html', to: '/quickconnect' },
+    { from: 'serveractivity.html', to: '/dashboard/activity' }
+];

src/apps/stable/routes/asyncRoutes/user.ts

@@ -1,6 +1,7 @@
 import { AsyncRoute } from '../../../../components/router/AsyncRoute';
 
 export const ASYNC_USER_ROUTES: AsyncRoute[] = [
+    { path: 'quickconnect', page: 'quickConnect' },
     { path: 'search.html', page: 'search' },
     { path: 'userprofile.html', page: 'user/userprofile' }
 ];

src/apps/stable/routes/legacyRoutes/user.ts

@@ -49,12 +49,6 @@ export const LEGACY_USER_ROUTES: LegacyRoute[] = [
             controller: 'user/home/index',
             view: 'user/home/index.html'
         }
-    }, {
-        path: 'mypreferencesquickconnect.html',
-        pageProps: {
-            controller: 'user/quickConnect/index',
-            view: 'user/quickConnect/index.html'
-        }
     }, {
         path: 'mypreferencesplayback.html',
         pageProps: {

src/apps/stable/routes/quickConnect/index.tsx

@@ -0,0 +1,116 @@
+import { getQuickConnectApi } from '@jellyfin/sdk/lib/utils/api/quick-connect-api';
+import React, { FC, FormEvent, useCallback, useMemo, useState } from 'react';
+import { Link, useSearchParams } from 'react-router-dom';
+
+import Page from 'components/Page';
+import globalize from 'scripts/globalize';
+import InputElement from 'elements/InputElement';
+import ButtonElement from 'elements/ButtonElement';
+import { useApi } from 'hooks/useApi';
+
+import './quickConnect.scss';
+
+const QuickConnectPage: FC = () => {
+    const { api, user } = useApi();
+    const [ searchParams ] = useSearchParams();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    const initialValue = useMemo(() => searchParams.get('code') ?? '', []);
+    const [ code, setCode ] = useState(initialValue);
+    const [ error, setError ] = useState<string>();
+    const [ success, setSuccess ] = useState(false);
+
+    const onCodeChange = useCallback((value: string) => {
+        setCode(value);
+    }, []);
+
+    const onSubmitCode = useCallback((e: FormEvent<HTMLFormElement>) => {
+        e.preventDefault();
+        setError(undefined);
+
+        const form = e.currentTarget;
+        if (!form.checkValidity()) {
+            setError('QuickConnectInvalidCode');
+            return;
+        }
+
+        if (!api) {
+            console.error('[QuickConnect] cannot authorize, missing api instance');
+            setError('UnknownError');
+            return;
+        }
+
+        const userId = searchParams.get('userId') ?? user?.Id;
+        const normalizedCode = code.replace(/\s/g, '');
+        console.log('[QuickConnect] authorizing code %s as user %s', normalizedCode, userId);
+
+        getQuickConnectApi(api)
+            .authorizeQuickConnect({
+                code: normalizedCode,
+                userId
+            })
+            .then(() => {
+                setSuccess(true);
+            })
+            .catch(() => {
+                setError('QuickConnectAuthorizeFail');
+            });
+    }, [api, code, searchParams, user?.Id]);
+
+    return (
+        <Page
+            id='quickConnectPreferencesPage'
+            title={globalize.translate('QuickConnect')}
+            className='mainAnimatedPage libraryPage userPreferencesPage noSecondaryNavPage'
+        >
+            <div className='padded-left padded-right padded-bottom-page'>
+                <form onSubmit={onSubmitCode}>
+                    <div className='verticalSection'>
+                        <h2 className='sectionTitle'>
+                            {globalize.translate('QuickConnect')}
+                        </h2>
+                        <div>
+                            {globalize.translate('QuickConnectDescription')}
+                        </div>
+                        <br />
+
+                        {error && (
+                            <div className='quickConnectError'>
+                                {globalize.translate(error)}
+                            </div>
+                        )}
+
+                        {success ? (
+                            <div style={{ textAlign: 'center' }}>
+                                <p>
+                                    {globalize.translate('QuickConnectAuthorizeSuccess')}
+                                </p>
+                                <Link to='/home.html' className='button-link emby-button'>
+                                    {globalize.translate('GoHome')}
+                                </Link>
+                            </div>
+                        ) : (
+                            <>
+                                <InputElement
+                                    containerClassName='inputContainer'
+                                    initialValue={initialValue}
+                                    onChange={onCodeChange}
+                                    id='txtQuickConnectCode'
+                                    label='LabelQuickConnectCode'
+                                    type='text'
+                                    options="inputmode='numeric' pattern='[0-9\s]*' minlength='6' required autocomplete='off'"
+                                />
+                                <ButtonElement
+                                    type='submit'
+                                    className='raised button-submit block'
+                                    title={globalize.translate('Authorize')}
+                                />
+                            </>
+                        )}
+                    </div>
+                </form>
+            </div>
+        </Page>
+    );
+};
+
+export default QuickConnectPage;

src/apps/stable/routes/quickConnect/quickConnect.scss

@@ -0,0 +1,7 @@
+.quickConnectError {
+    border-radius: 0.2em;
+    background-color: #160b0b;
+    color: #f4c7c3;
+    padding: 0.7em 0.5em;
+    margin-bottom: 1em;
+}

src/components/router/Redirect.tsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import { Navigate, Route } from 'react-router-dom';
+
+export interface Redirect {
+    from: string
+    to: string
+}
+
+export function toRedirectRoute({ from, to }: Redirect) {
+    return (
+        <Route
+            key={from}
+            path={from}
+            element={<Navigate replace to={to} />}
+        />
+    );
+}

src/controllers/user/menu/index.js

@@ -31,7 +31,7 @@ export default function (view, params) {
         page.querySelector('.lnkHomePreferences').setAttribute('href', '#/mypreferenceshome.html?userId=' + userId);
         page.querySelector('.lnkPlaybackPreferences').setAttribute('href', '#/mypreferencesplayback.html?userId=' + userId);
         page.querySelector('.lnkSubtitlePreferences').setAttribute('href', '#/mypreferencessubtitles.html?userId=' + userId);
-        page.querySelector('.lnkQuickConnectPreferences').setAttribute('href', '#/mypreferencesquickconnect.html?userId=' + userId);
+        page.querySelector('.lnkQuickConnectPreferences').setAttribute('href', '#/quickconnect?userId=' + userId);
         page.querySelector('.lnkControlsPreferences').setAttribute('href', '#/mypreferencescontrols.html?userId=' + userId);
 
         const supportsClientSettings = appHost.supports('clientsettings');

src/controllers/user/quickConnect/helper.js

@@ -1,17 +0,0 @@
-import globalize from '../../../scripts/globalize';
-import toast from '../../../components/toast/toast';
-
-export const authorize = (code, userId) => {
-    const url = ApiClient.getUrl('/QuickConnect/Authorize?Code=' + code + '&UserId=' + userId);
-    ApiClient.ajax({
-        type: 'POST',
-        url: url
-    }, true).then(() => {
-        toast(globalize.translate('QuickConnectAuthorizeSuccess'));
-    }).catch(() => {
-        toast(globalize.translate('QuickConnectAuthorizeFail'));
-    });
-
-    // prevent bubbling
-    return false;
-};

src/controllers/user/quickConnect/index.html

@@ -1,15 +0,0 @@
-<div id="quickConnectPreferencesPage" data-role="page" class="page libraryPage userPreferencesPage noSecondaryNavPage" data-title="${QuickConnect}" data-backbutton="true" style="margin: 0 auto; max-width: 54em">
-    <form class="quickConnectSettingsContainer">
-        <div class="verticalSection">
-            <h2 class="sectionTitle">${QuickConnect}</h2>
-            <div>${QuickConnectDescription}</div>
-            <br />
-            <div class="inputContainer">
-                <input is="emby-input" type="text" inputmode="numeric" pattern="[0-9\s]*" minlength="6" required id="txtQuickConnectCode" label="${LabelQuickConnectCode}" autocomplete="off" />
-            </div>
-            <button id="btnQuickConnectAuthorize" is="emby-button" type="submit" class="raised button-submit block">
-                <span>${Authorize}</span>
-            </button>
-        </div>
-    </form>
-</div>

src/controllers/user/quickConnect/index.js

@@ -1,25 +0,0 @@
-import { authorize } from './helper';
-import globalize from '../../../scripts/globalize';
-import toast from '../../../components/toast/toast';
-
-export default function (view, params) {
-    const userId = params.userId || ApiClient.getCurrentUserId();
-
-    view.addEventListener('viewshow', function () {
-        const codeElement = view.querySelector('#txtQuickConnectCode');
-
-        view.querySelector('.quickConnectSettingsContainer').addEventListener('submit', (e) => {
-            e.preventDefault();
-
-            if (!codeElement.validity.valid) {
-                toast(globalize.translate('QuickConnectInvalidCode'));
-
-                return;
-            }
-
-            // Remove spaces from code
-            const normalizedCode = codeElement.value.replace(/\s/g, '');
-            authorize(normalizedCode, userId);
-        });
-    });
-}

src/elements/InputElement.tsx

@@ -1,32 +1,72 @@
-import React, { FunctionComponent } from 'react';
+import React, { type FC, useCallback, useEffect, useMemo, useRef } from 'react';
+
 import globalize from '../scripts/globalize';
 
-const createInputElement = ({ type, id, label, options }: { type?: string, id?: string, label?: string, options?: string }) => ({
+interface CreateInputElementParams {
+    type?: string
+    id?: string
+    label?: string
+    initialValue?: string
+    options?: string
+}
+
+const createInputElement = ({ type, id, label, initialValue, options }: CreateInputElementParams) => ({
     __html: `<input
         is="emby-input"
         type="${type}"
         id="${id}"
         label="${label}"
+        value="${initialValue}"
         ${options}
     />`
 });
 
-type IProps = {
+type InputElementProps = {
-    type?: string;
+    containerClassName?: string
-    id?: string;
+    onChange?: (value: string) => void
-    label?: string;
+} & CreateInputElementParams;
-    options?: string
+
-};
+const InputElement: FC<InputElementProps> = ({
+    containerClassName,
+    initialValue,
+    onChange = () => { /* no-op */ },
+    type,
+    id,
+    label,
+    options = ''
+}) => {
+    const container = useRef<HTMLDivElement>(null);
+
+    // NOTE: We need to memoize the input html because any re-render will break the webcomponent
+    const inputHtml = useMemo(() => (
+        createInputElement({
+            type,
+            id,
+            label: globalize.translate(label),
+            initialValue,
+            options
+        })
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    ), []);
+
+    const onInput = useCallback((e: Event) => {
+        onChange((e.target as HTMLInputElement).value);
+    }, [ onChange ]);
+
+    useEffect(() => {
+        const inputElement = container?.current?.querySelector<HTMLInputElement>('input');
+        inputElement?.addEventListener('input', onInput);
+
+        return () => {
+            inputElement?.removeEventListener('input', onInput);
+        };
+    }, [ container, onInput ]);
 
-const InputElement: FunctionComponent<IProps> = ({ type, id, label, options }: IProps) => {
     return (
         <div
-            dangerouslySetInnerHTML={createInputElement({
+            ref={container}
-                type: type,
+            className={containerClassName}
-                id: id,
+            dangerouslySetInnerHTML={inputHtml}
-                label: globalize.translate(label),
-                options: options ? options : ''
-            })}
         />
     );
 };

src/strings/en-us.json

@@ -297,6 +297,7 @@
     "Genre": "Genre",
     "Genres": "Genres",
     "GetThePlugin": "Get the Plugin",
+    "GoHome": "Go Home",
     "GoogleCastUnsupported": "Google Cast Unsupported",
     "GridView": "Grid View",
     "GroupBySeries": "Group by series",
@@ -1361,7 +1362,7 @@
     "QuickConnectActivationSuccessful": "Successfully activated",
     "QuickConnectAuthorizeCode": "Enter code {0} to login",
     "QuickConnectAuthorizeFail": "Unknown Quick Connect code",
-    "QuickConnectAuthorizeSuccess": "Request authorized",
+    "QuickConnectAuthorizeSuccess": "You have successfully authenticated your device!",
     "QuickConnectDeactivated": "Quick Connect was deactivated before the login request could be approved",
     "QuickConnectDescription": "To sign in with Quick Connect, select the 'Quick Connect' button on the device you are logging in from and enter the displayed code below.",
     "QuickConnectInvalidCode": "Invalid Quick Connect code",
@@ -1557,6 +1558,7 @@
     "Typewriter": "Typewriter",
     "Uniform": "Uniform",
     "UninstallPluginConfirmation": "Are you sure you wish to uninstall {0}?",
+    "UnknownError": "An unknown error occurred.",
     "Unmute": "Unmute",
     "Unplayed": "Unplayed",
     "Unrated": "Unrated",