@atproto/oauth-scopes/src/lib/lexicon.ts

A library for manipulating and validating ATproto OAuth scopes in TypeScript.

import { ParamValue } from './syntax.js'

// @NOTE Not types from from '@atproto/lex-document' because we want a readonly
// version here to prevent accidental mutation.

export type LexiconPermission<P extends string = string> = {
  readonly type: 'permission'
  readonly resource: P
  readonly [x: string]: undefined | ParamValue | readonly ParamValue[]
}

type LangMap = { readonly [Lang in string]?: string }

export type LexiconPermissionSet = {
  readonly type: 'permission-set'
  readonly permissions: readonly LexiconPermission<string>[]
  readonly title?: string
  readonly 'title:lang'?: LangMap
  readonly detail?: string
  readonly 'detail:lang'?: LangMap
}