@owlmeans/web-oauth 0.1.18-rc.1

package/src/hooks/use-oauth-consent.ts

@@ -0,0 +1,163 @@
+import { useCallback, useEffect, useRef, useState } from 'react'
+import { useContext, useNavigate } from '@owlmeans/client'
+import { DEFAULT_ALIAS as AUTH_SERVICE } from '@owlmeans/client-auth'
+import type { AuthService } from '@owlmeans/auth-common'
+import { DISPATCHER } from '@owlmeans/auth'
+import { suspendFlow } from '@owlmeans/client-flow'
+import { makeFlowModel } from '@owlmeans/flow'
+import { ResilientError } from '@owlmeans/error'
+import {
+  makeOAuthProtocols, oauthFlow, OAuthFlowStep, OAUTH_PAYLOAD_KIND, OAUTH_PAYLOAD_REF
+} from '@owlmeans/oauth'
+import type { ConsentView, OAuthEntrypointOptions } from '@owlmeans/oauth'
+import type { ClientEntrypoint } from '@owlmeans/client-entrypoint'
+import { OAUTH_SUSPEND_TTL_MS } from '../consts.js'
+
+export type ConsentStage = 'checking' | 'signing-in' | 'loading' | 'ready' | 'deciding' | 'done' | 'error'
+
+/** Why the screen cannot go on — the screen phrases each kind as ONE sentence, never the wire text. */
+export type ConsentErrorKind = 'missing' | 'not-found' | 'expired' | 'forbidden' | 'failed'
+
+export interface UseOAuthConsent {
+  stage: ConsentStage
+  view: ConsentView | null
+  /** The raw failure, for a log; what a person reads is `errorKind`. */
+  error: string | null
+  errorKind: ConsentErrorKind | null
+  approve: () => Promise<void>
+  deny: () => Promise<void>
+  /** Sign the current session out and go through the sign-in again, returning to this request. */
+  switchAccount: () => Promise<void>
+}
+
+const errorKindOf = (message: string): ConsentErrorKind =>
+  message.includes('request-expired') ? 'expired'
+    : message.includes('request-not-found') ? 'not-found'
+      : message.includes('forbidden') ? 'forbidden'
+        : 'failed'
+
+/**
+ * The whole consent screen's logic, headless — so the rendered component stays a thin shell over
+ * whatever a consuming app's own primitives look like, the same split `@owlmeans/web-auth-token`
+ * draws between its panel and its hook.
+ *
+ * `ref` is whatever the URL query named: a code grant's request id, or a device grant's user
+ * code — `resolveRequestRef` on the server sorts out which. `aliases` lets an app that mounted
+ * these entrypoints under a different parent still reach them; the defaults are what
+ * `oauthEntrypoints` binds.
+ */
+export const useOAuthConsent = (ref: string | null, aliases?: OAuthEntrypointOptions): UseOAuthConsent => {
+  const context = useContext()
+  const nav = useNavigate()
+  const protocols = makeOAuthProtocols(aliases)
+
+  const [stage, setStage] = useState<ConsentStage>('checking')
+  const [view, setView] = useState<ConsentView | null>(null)
+  const [error, setError] = useState<string | null>(null)
+  const [errorKind, setErrorKind] = useState<ConsentErrorKind | null>(null)
+  const suspending = useRef(false)
+
+  const fail = (e: unknown): void => {
+    const message = ResilientError.ensure(e instanceof Error ? e : String(e)).message
+    setError(message)
+    setErrorKind(errorKindOf(message))
+    setStage('error')
+  }
+
+  /**
+   * Suspend the consent flow at its `sign-in` step and leave for the dispatcher. Suspending AT
+   * that step is what makes resuming land back on `consent` with the same ref.
+   */
+  const leaveForSignIn = async (target: string): Promise<void> => {
+    const model = await makeFlowModel(oauthFlow)
+    model.updatePayload({ [OAUTH_PAYLOAD_REF]: target })
+    model.transit(OAuthFlowStep.SignIn, true)
+    await suspendFlow(context, model, { expiresAt: Date.now() + OAUTH_SUSPEND_TTL_MS })
+
+    const dispatcher = await context.entrypoint<ClientEntrypoint<string>>(DISPATCHER).url()
+    window.location.href = dispatcher
+  }
+
+  useEffect(() => {
+    if (ref == null || ref === '') {
+      setError('Nothing to approve.')
+      setErrorKind('missing')
+      setStage('error')
+
+      return
+    }
+
+    let cancelled = false
+    void (async () => {
+      const auth = context.service<AuthService>(AUTH_SERVICE)
+      const token = await auth.authenticated()
+
+      if (token == null || token === '') {
+        if (suspending.current) return
+        suspending.current = true
+        setStage('signing-in')
+
+        await leaveForSignIn(ref)
+
+        return
+      }
+
+      setStage('loading')
+      try {
+        const loaded = await context.entrypoint(protocols.load).call({ params: { ref } })
+        if (!cancelled) {
+          setView(loaded)
+          setStage('ready')
+        }
+      } catch (e) {
+        if (!cancelled) fail(e)
+      }
+    })()
+
+    return () => { cancelled = true }
+  }, [ref])
+
+  const decide = useCallback(async (action: 'approve' | 'deny') => {
+    if (ref == null) return
+    setStage('deciding')
+    try {
+      const protocol = action === 'approve' ? protocols.approve : protocols.deny
+      const result = await context.entrypoint(protocol).call({ params: { ref } })
+      if (result.redirect != null) {
+        window.location.href = result.redirect
+
+        return
+      }
+      // Device grant: nothing to redirect to — the poller catches up on its own. `approve` and
+      // `deny` both lead to `done` from `consent`; asking the flow for that step's module is what
+      // keeps this in step with the shared definition instead of hardcoding the destination.
+      const model = await makeFlowModel(oauthFlow)
+      model.updatePayload({ [OAUTH_PAYLOAD_KIND]: view?.kind ?? '', [OAUTH_PAYLOAD_REF]: ref })
+      model.transit(action, true)
+      const destination = model.step()
+      setStage('done')
+      await nav.navigate(
+        context.entrypoint<ClientEntrypoint<string>>(destination.module!), { query: model.payload() }
+      )
+    } catch (e) {
+      fail(e)
+    }
+  }, [ref, view])
+
+  const switchAccount = useCallback(async () => {
+    if (ref == null || ref === '') return
+    try {
+      await context.service<AuthService>(AUTH_SERVICE).update(undefined)
+      await leaveForSignIn(ref)
+    } catch (e) {
+      fail(e)
+    }
+  }, [ref])
+
+  return {
+    stage, view, error, errorKind,
+    approve: () => decide('approve'),
+    deny: () => decide('deny'),
+    switchAccount,
+  }
+}

package/src/i18n/be.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Праверка сеанса…",
+    "loading": "Загрузка запыту…",
+    "framed": "Гэты экран нельга паказаць унутры іншай старонкі. Адкрыйце яго напрамую.",
+    "error": "Нешта пайшло не так. Паспрабуйце яшчэ раз з праграмы, якая накіравала вас сюды.",
+    "title": "{{client}} хоча атрымаць доступ да вашага акаўнта",
+    "known": "Вы ўжо карысталіся гэтай праграмай раней.",
+    "known-by-host": "Запыт ад {{host}}.",
+    "unverified": "Гэтая праграма зарэгістравалася самастойна і не была правераная.",
+    "device-code": "Код: {{code}}",
+    "device-name": "Прылада: {{name}}",
+    "redirect-host": "Вы вернецеся на {{host}}.",
+    "localhost-warning": "Гэтая праграма зарэгістравала толькі адрасы на вашым уласным камп'ютары. Пацвярджайце гэта, толькі калі вы самі толькі што пачалі ўваход.",
+    "scope": "Запытаны доступ: {{scopes}}",
+    "approve": "Дазволіць",
+    "deny": "Адхіліць",
+    "error-missing": "Тут няма чаго пацвярджаць. Пачніце ўваход нанова з праграмы.",
+    "error-not-found": "Гэты запыт невядомы або ўжо выкарыстаны. Пачніце ўваход нанова з праграмы.",
+    "error-expired": "Тэрмін дзеяння гэтага запыту скончыўся. Пачніце ўваход нанова з праграмы.",
+    "error-forbidden": "Акаўнт гэтага тыпу не можа пацвярджаць доступ. Увайдзіце ў акаўнт, які вы выкарыстоўваеце ў OwlMeans, і паспрабуйце яшчэ раз.",
+    "switch-account": "Выкарыстаць іншы акаўнт"
+  },
+  "device": {
+    "title": "Падключыць прыладу",
+    "description": "Увядзіце код, паказаны праграмай, да якой вы падключаецеся.",
+    "code-label": "Код",
+    "continue": "Працягнуць"
+  },
+  "done": {
+    "title": "Вы ўвайшлі ў сістэму",
+    "message": "Можаце закрыць гэтае акно і працягнуць працу ў праграме, якая накіравала вас сюды.",
+    "device-message": "Можаце закрыць гэтае акно. Праграма падхопіць гэта аўтаматычна."
+  }
+}

package/src/i18n/de.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Sitzung wird überprüft…",
+    "loading": "Anfrage wird geladen…",
+    "framed": "Dieser Bildschirm kann nicht innerhalb einer anderen Seite angezeigt werden. Öffne ihn direkt.",
+    "error": "Etwas ist schiefgelaufen. Versuche es erneut über die Anwendung, die dich hierher geschickt hat.",
+    "title": "{{client}} möchte auf dein Konto zugreifen",
+    "known": "Du hast diese Anwendung bereits verwendet.",
+    "known-by-host": "Anfrage von {{host}}.",
+    "unverified": "Diese Anwendung hat sich selbst registriert und wurde nicht verifiziert.",
+    "device-code": "Code: {{code}}",
+    "device-name": "Gerät: {{name}}",
+    "redirect-host": "Du kehrst zu {{host}} zurück.",
+    "localhost-warning": "Diese Anwendung hat nur Adressen auf deinem eigenen Computer registriert. Bestätige dies nur, wenn du die Anmeldung gerade selbst gestartet hast.",
+    "scope": "Angeforderter Zugriff: {{scopes}}",
+    "approve": "Genehmigen",
+    "deny": "Ablehnen",
+    "error-missing": "Hier gibt es nichts zu bestätigen. Starte die Anmeldung erneut in der Anwendung.",
+    "error-not-found": "Diese Anfrage ist unbekannt oder wurde bereits verwendet. Starte die Anmeldung erneut in der Anwendung.",
+    "error-expired": "Diese Anfrage ist abgelaufen. Starte die Anmeldung erneut in der Anwendung.",
+    "error-forbidden": "Diese Art von Konto kann keinen Zugriff bestätigen. Melde dich mit dem Konto an, das du für OwlMeans verwendest, und versuche es erneut.",
+    "switch-account": "Anderes Konto verwenden"
+  },
+  "device": {
+    "title": "Gerät verbinden",
+    "description": "Gib den Code ein, den die Anwendung anzeigt, mit der du dich verbindest.",
+    "code-label": "Code",
+    "continue": "Weiter"
+  },
+  "done": {
+    "title": "Du bist angemeldet",
+    "message": "Du kannst dieses Fenster schließen und in der Anwendung fortfahren, die dich hierher geschickt hat.",
+    "device-message": "Du kannst dieses Fenster schließen. Die Anwendung übernimmt dies automatisch."
+  }
+}

package/src/i18n/en.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Checking your session…",
+    "loading": "Loading the request…",
+    "framed": "This screen cannot be shown inside another page. Open it directly.",
+    "error": "Something went wrong. Try again from the application that sent you here.",
+    "title": "{{client}} wants to access your account",
+    "known": "You've used this application before.",
+    "known-by-host": "Requesting from {{host}}.",
+    "unverified": "This application registered itself and has not been verified.",
+    "device-code": "Code: {{code}}",
+    "device-name": "Device: {{name}}",
+    "redirect-host": "You will return to {{host}}.",
+    "localhost-warning": "This application only registered addresses on your own computer. Only approve this if you started the sign-in yourself, just now.",
+    "scope": "Access requested: {{scopes}}",
+    "approve": "Approve",
+    "deny": "Deny",
+    "error-missing": "There is nothing to approve here. Start the sign-in again from the application.",
+    "error-not-found": "This request is unknown or has already been used. Start the sign-in again from the application.",
+    "error-expired": "This request has expired. Start the sign-in again from the application.",
+    "error-forbidden": "This kind of account cannot approve access. Sign in with the account you use for OwlMeans and try again.",
+    "switch-account": "Use another account"
+  },
+  "device": {
+    "title": "Connect a device",
+    "description": "Enter the code shown by the application you're connecting.",
+    "code-label": "Code",
+    "continue": "Continue"
+  },
+  "done": {
+    "title": "You're signed in",
+    "message": "You may close this window and continue in the application that sent you here.",
+    "device-message": "You may close this window. The application will pick this up automatically."
+  }
+}

package/src/i18n/es.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Comprobando tu sesión…",
+    "loading": "Cargando la solicitud…",
+    "framed": "Esta pantalla no puede mostrarse dentro de otra página. Ábrela directamente.",
+    "error": "Algo salió mal. Vuelve a intentarlo desde la aplicación que te envió aquí.",
+    "title": "{{client}} quiere acceder a tu cuenta",
+    "known": "Ya has usado esta aplicación antes.",
+    "known-by-host": "Solicitud desde {{host}}.",
+    "unverified": "Esta aplicación se registró por sí misma y no ha sido verificada.",
+    "device-code": "Código: {{code}}",
+    "device-name": "Dispositivo: {{name}}",
+    "redirect-host": "Volverás a {{host}}.",
+    "localhost-warning": "Esta aplicación solo registró direcciones en tu propio equipo. Aprueba esto únicamente si tú mismo iniciaste el inicio de sesión, justo ahora.",
+    "scope": "Acceso solicitado: {{scopes}}",
+    "approve": "Aprobar",
+    "deny": "Rechazar",
+    "error-missing": "Aquí no hay nada que aprobar. Inicia sesión de nuevo desde la aplicación.",
+    "error-not-found": "Esta solicitud es desconocida o ya se ha usado. Inicia sesión de nuevo desde la aplicación.",
+    "error-expired": "Esta solicitud ha caducado. Inicia sesión de nuevo desde la aplicación.",
+    "error-forbidden": "Este tipo de cuenta no puede aprobar el acceso. Inicia sesión con la cuenta que usas en OwlMeans e inténtalo de nuevo.",
+    "switch-account": "Usar otra cuenta"
+  },
+  "device": {
+    "title": "Conectar un dispositivo",
+    "description": "Introduce el código que muestra la aplicación a la que te estás conectando.",
+    "code-label": "Código",
+    "continue": "Continuar"
+  },
+  "done": {
+    "title": "Has iniciado sesión",
+    "message": "Puedes cerrar esta ventana y continuar en la aplicación que te envió aquí.",
+    "device-message": "Puedes cerrar esta ventana. La aplicación lo detectará automáticamente."
+  }
+}

package/src/i18n/pl.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Sprawdzanie sesji…",
+    "loading": "Wczytywanie żądania…",
+    "framed": "Tego ekranu nie można wyświetlić wewnątrz innej strony. Otwórz go bezpośrednio.",
+    "error": "Coś poszło nie tak. Spróbuj ponownie z aplikacji, która Cię tu skierowała.",
+    "title": "{{client}} chce uzyskać dostęp do Twojego konta",
+    "known": "Korzystałeś już z tej aplikacji.",
+    "known-by-host": "Żądanie z {{host}}.",
+    "unverified": "Ta aplikacja zarejestrowała się samodzielnie i nie została zweryfikowana.",
+    "device-code": "Kod: {{code}}",
+    "device-name": "Urządzenie: {{name}}",
+    "redirect-host": "Wrócisz do {{host}}.",
+    "localhost-warning": "Ta aplikacja zarejestrowała wyłącznie adresy na Twoim własnym komputerze. Zatwierdź to tylko wtedy, gdy sam przed chwilą rozpocząłeś logowanie.",
+    "scope": "Żądany dostęp: {{scopes}}",
+    "approve": "Zatwierdź",
+    "deny": "Odrzuć",
+    "error-missing": "Nie ma tu nic do zatwierdzenia. Rozpocznij logowanie od nowa w aplikacji.",
+    "error-not-found": "To żądanie jest nieznane lub zostało już wykorzystane. Rozpocznij logowanie od nowa w aplikacji.",
+    "error-expired": "To żądanie wygasło. Rozpocznij logowanie od nowa w aplikacji.",
+    "error-forbidden": "Ten rodzaj konta nie może zatwierdzać dostępu. Zaloguj się kontem, którego używasz w OwlMeans, i spróbuj ponownie.",
+    "switch-account": "Użyj innego konta"
+  },
+  "device": {
+    "title": "Połącz urządzenie",
+    "description": "Wpisz kod wyświetlony przez aplikację, z którą się łączysz.",
+    "code-label": "Kod",
+    "continue": "Dalej"
+  },
+  "done": {
+    "title": "Jesteś zalogowany",
+    "message": "Możesz zamknąć to okno i kontynuować w aplikacji, która Cię tu skierowała.",
+    "device-message": "Możesz zamknąć to okno. Aplikacja wykryje to automatycznie."
+  }
+}

package/src/i18n/ru.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Проверка сеанса…",
+    "loading": "Загрузка запроса…",
+    "framed": "Этот экран нельзя показать внутри другой страницы. Откройте его напрямую.",
+    "error": "Что-то пошло не так. Повторите попытку из приложения, которое направило вас сюда.",
+    "title": "{{client}} запрашивает доступ к вашей учётной записи",
+    "known": "Вы уже использовали это приложение раньше.",
+    "known-by-host": "Запрос от {{host}}.",
+    "unverified": "Это приложение зарегистрировалось самостоятельно и не было проверено.",
+    "device-code": "Код: {{code}}",
+    "device-name": "Устройство: {{name}}",
+    "redirect-host": "Вы вернётесь на {{host}}.",
+    "localhost-warning": "Это приложение зарегистрировало только адреса на вашем собственном компьютере. Подтверждайте это, только если вы сами только что начали вход.",
+    "scope": "Запрашиваемый доступ: {{scopes}}",
+    "approve": "Разрешить",
+    "deny": "Отклонить",
+    "error-missing": "Здесь нечего подтверждать. Начните вход заново из приложения.",
+    "error-not-found": "Этот запрос неизвестен или уже использован. Начните вход заново из приложения.",
+    "error-expired": "Срок действия этого запроса истёк. Начните вход заново из приложения.",
+    "error-forbidden": "Аккаунт этого типа не может подтверждать доступ. Войдите в аккаунт, который вы используете в OwlMeans, и повторите попытку.",
+    "switch-account": "Использовать другой аккаунт"
+  },
+  "device": {
+    "title": "Подключить устройство",
+    "description": "Введите код, показанный приложением, к которому вы подключаетесь.",
+    "code-label": "Код",
+    "continue": "Продолжить"
+  },
+  "done": {
+    "title": "Вы вошли в систему",
+    "message": "Можно закрыть это окно и продолжить работу в приложении, которое направило вас сюда.",
+    "device-message": "Можно закрыть это окно. Приложение подхватит это автоматически."
+  }
+}

package/src/i18n/uk.json

@@ -0,0 +1,35 @@
+{
+  "consent": {
+    "checking": "Перевірка сеансу…",
+    "loading": "Завантаження запиту…",
+    "framed": "Цей екран не можна показати всередині іншої сторінки. Відкрийте його напряму.",
+    "error": "Щось пішло не так. Спробуйте ще раз із застосунку, який направив вас сюди.",
+    "title": "{{client}} хоче отримати доступ до вашого облікового запису",
+    "known": "Ви вже користувалися цим застосунком раніше.",
+    "known-by-host": "Запит від {{host}}.",
+    "unverified": "Цей застосунок зареєструвався самостійно і не був перевірений.",
+    "device-code": "Код: {{code}}",
+    "device-name": "Пристрій: {{name}}",
+    "redirect-host": "Ви повернетеся до {{host}}.",
+    "localhost-warning": "Цей застосунок зареєстрував лише адреси на вашому власному комп'ютері. Підтверджуйте це, лише якщо ви щойно самі розпочали вхід.",
+    "scope": "Запитуваний доступ: {{scopes}}",
+    "approve": "Дозволити",
+    "deny": "Відхилити",
+    "error-missing": "Тут нічого підтверджувати. Почніть вхід заново із застосунку.",
+    "error-not-found": "Цей запит невідомий або вже використаний. Почніть вхід заново із застосунку.",
+    "error-expired": "Термін дії цього запиту минув. Почніть вхід заново із застосунку.",
+    "error-forbidden": "Обліковий запис цього типу не може підтверджувати доступ. Увійдіть в обліковий запис, який ви використовуєте в OwlMeans, і спробуйте ще раз.",
+    "switch-account": "Використати інший обліковий запис"
+  },
+  "device": {
+    "title": "Підключити пристрій",
+    "description": "Введіть код, показаний застосунком, до якого ви підключаєтеся.",
+    "code-label": "Код",
+    "continue": "Продовжити"
+  },
+  "done": {
+    "title": "Ви увійшли в систему",
+    "message": "Можете закрити це вікно й продовжити роботу в застосунку, який направив вас сюди.",
+    "device-message": "Можете закрити це вікно. Застосунок підхопить це автоматично."
+  }
+}

package/src/i18n.ts

@@ -0,0 +1,18 @@
+import { addI18nLib } from '@owlmeans/i18n'
+import { OAUTH_I18N } from './consts.js'
+
+import en from './i18n/en.json' with { type: 'json' }
+import pl from './i18n/pl.json' with { type: 'json' }
+import ru from './i18n/ru.json' with { type: 'json' }
+import be from './i18n/be.json' with { type: 'json' }
+import uk from './i18n/uk.json' with { type: 'json' }
+import es from './i18n/es.json' with { type: 'json' }
+import de from './i18n/de.json' with { type: 'json' }
+
+addI18nLib('en', OAUTH_I18N, en)
+addI18nLib('pl', OAUTH_I18N, pl)
+addI18nLib('ru', OAUTH_I18N, ru)
+addI18nLib('be', OAUTH_I18N, be)
+addI18nLib('uk', OAUTH_I18N, uk)
+addI18nLib('es', OAUTH_I18N, es)
+addI18nLib('de', OAUTH_I18N, de)

package/src/index.ts

@@ -0,0 +1,6 @@
+export * from './consts.js'
+export * from './append.js'
+export * from './entrypoints.js'
+export * from './hooks/use-oauth-consent.js'
+export * from './components/index.js'
+export * from './i18n.js'