OAuth client improvements (#4216)

* wip

* Various OAuth client & API improvements

* pnpm lock

* Minor typing improvements

* ci

* fix

Author: matthieusieben

.changeset/chilly-goats-tell.md

@@ -0,0 +1,5 @@
+---
+"@atproto/api": patch
+---
+
+Create a dedicated type for the `proxy` property

.changeset/cold-toys-know.md

@@ -0,0 +1,5 @@
+---
+"@atproto/oauth-types": patch
+---
+
+Expose new utilities to build and work with atproto loopback client metadata

.changeset/old-spiders-hide.md

@@ -0,0 +1,5 @@
+---
+"@atproto/api": patch
+---
+
+Improve validation when setting an `Agent`'s `proxy` property

.changeset/perfect-onions-crash.md

@@ -0,0 +1,5 @@
+---
+"@atproto/oauth-client": patch
+---
+
+Use `AbortSignal.timeout` to generate timeout based signals

.changeset/tidy-doors-punch.md

@@ -0,0 +1,5 @@
+---
+"@atproto/oauth-types": patch
+---
+
+Improve validation of `AtprotoOAuthScope`

.changeset/tough-islands-smell.md

@@ -0,0 +1,5 @@
+---
+"@atproto/oauth-types": patch
+---
+
+Add `AtprotoOAuthTokenResponse` schema

.changeset/wicked-foxes-beg.md

@@ -0,0 +1,5 @@
+---
+'@atproto/did': patch
+---
+
+Minor typing improvements

packages/api/src/agent.ts

@@ -33,17 +33,18 @@ import * as predicate from './predicate'
 import { SessionManager } from './session-manager'
 import {
   AtpAgentGlobalOpts,
+  AtprotoProxy,
   AtprotoServiceType,
   BskyFeedViewPreference,
   BskyInterestsPreference,
   BskyPreferences,
   BskyThreadViewPreference,
+  asAtprotoProxy,
+  asDid,
+  isDid,
 } from './types'
 import {
-  Did,
-  asDid,
   getSavedFeedType,
-  isDid,
   sanitizeMutedWordValue,
   savedFeedsToUriArrays,
   validateNux,
@@ -187,12 +188,11 @@ export class Agent extends XrpcClient {
 
   //#region ATPROTO proxy configuration utilities
 
-  proxy?: `${Did}#${AtprotoServiceType}`
+  proxy?: AtprotoProxy
 
-  configureProxy(value: `${Did}#${AtprotoServiceType}` | null) {
+  configureProxy(value: AtprotoProxy | null) {
     if (value === null) this.proxy = undefined
-    else if (isDid(value)) this.proxy = value
-    else throw new TypeError('Invalid proxy DID')
+    else this.proxy = asAtprotoProxy(value)
   }
 
   /** @deprecated use {@link configureProxy} instead */

packages/api/src/types.ts

@@ -1,11 +1,53 @@
 import { AppBskyActorDefs } from './client'
 import { ModerationPrefs } from './moderation/types'
 
-/**
- * Supported proxy targets
- */
-type UnknownServiceType = string & NonNullable<unknown>
+export type UnknownServiceType = string & NonNullable<unknown>
 export type AtprotoServiceType = 'atproto_labeler' | UnknownServiceType
+export function isAtprotoServiceType<T extends string>(
+  input: T,
+): input is T & AtprotoServiceType {
+  return !input.includes(' ') && !input.includes('#')
+}
+
+// @TODO use tools from @atproto/did
+export type Did = `did:${string}:${string}`
+export function isDid<T extends string>(input: T): input is T & Did {
+  if (!input.startsWith('did:')) return false
+  if (input.length < 8) return false
+  if (input.length > 2048) return false
+  const msidx = input.indexOf(':', 4)
+  return msidx > 4 && msidx < input.length - 1
+}
+
+export function assertDid(input: string): asserts input is Did {
+  if (!isDid(input)) throw new TypeError(`Invalid DID: ${input}`)
+}
+
+export function asDid<T extends string>(input: T) {
+  assertDid(input)
+  return input
+}
+
+export type AtprotoProxy = `${Did}#${AtprotoServiceType}`
+export function isAtprotoProxy(input: string): input is AtprotoProxy {
+  const { length, [0]: did, [1]: service } = input.split('#')
+  return length === 2 && isDid(did) && isAtprotoServiceType(service)
+}
+
+export function assertAtprotoProxy(
+  input: string,
+): asserts input is AtprotoProxy {
+  if (!isAtprotoProxy(input)) {
+    throw new TypeError(
+      `Invalid DID reference: ${input} (must be of the form did:example:alice#service)`,
+    )
+  }
+}
+
+export function asAtprotoProxy<T extends string>(input: T) {
+  assertAtprotoProxy(input)
+  return input
+}
 
 /**
  * Used by the PersistSessionHandler to indicate what change occurred

packages/api/src/util.ts

@@ -82,21 +82,6 @@ export function validateSavedFeed(savedFeed: AppBskyActorDefs.SavedFeed) {
   }
 }
 
-export type Did = `did:${string}`
-
-// @TODO use tools from @atproto/did
-export const isDid = (str: unknown): str is Did =>
-  typeof str === 'string' &&
-  str.startsWith('did:') &&
-  str.includes(':', 4) &&
-  str.length > 8 &&
-  str.length <= 2048
-
-export const asDid = (value: string): Did => {
-  if (isDid(value)) return value
-  throw new TypeError(`Invalid DID: ${value}`)
-}
-
 export const nuxSchema = z
   .object({
     id: z.string().max(64),