@atproto/pds 0.4.122 → 0.4.124

package/src/context.ts

@@ -10,7 +10,7 @@ import { KmsKeypair, S3BlobStore } from '@atproto/aws'
 import * as crypto from '@atproto/crypto'
 import { IdResolver } from '@atproto/identity'
 import {
-  AccessTokenType,
+  AccessTokenMode,
   JoseKey,
   OAuthProvider,
   OAuthVerifier,
@@ -369,7 +369,7 @@ export class AppContext {
           // entryway), there is no need to use JWTs as access tokens. Instead,
           // the PDS can use tokenId as access tokens. This allows the PDS to
           // always use up-to-date token data from the token store.
-          accessTokenType: AccessTokenType.id,
+          accessTokenMode: AccessTokenMode.light,
         })
       : undefined
 

package/src/db/cast.ts

@@ -1,59 +1,52 @@
 export type DateISO = `${string}T${string}Z`
-export const toDateISO = (date: Date): DateISO => date.toISOString() as DateISO
-export const fromDateISO = (date: DateISO): Date => new Date(date)
+export function toDateISO(date: Date) {
+  return date.toISOString() as DateISO
+}
+export function fromDateISO(dateStr: DateISO) {
+  return new Date(dateStr)
+}
+
+/**
+ * Allows to ensure that {@link JsonEncoded} is not used with non-JSON
+ * serializable values (e.g. {@link Date} or {@link Function}s).
+ */
+export type Encodable =
+  | string
+  | number
+  | boolean
+  | null
+  | readonly Encodable[]
+  | { readonly [_ in string]?: Encodable }
+
+export type JsonString<T extends Encodable> = T extends readonly unknown[]
+  ? `[${string}]`
+  : T extends object
+    ? `{${string}}`
+    : T extends string
+      ? `"${string}"`
+      : T extends number
+        ? `${number}`
+        : T extends boolean
+          ? `true` | `false`
+          : T extends null
+            ? `null`
+            : never
 
-export type Json = string
-export const toJson = (obj: unknown): Json => {
-  const json = JSON.stringify(obj)
+declare const jsonEncodedType: unique symbol
+export type JsonEncoded<T extends Encodable = Encodable> = JsonString<T> & {
+  [jsonEncodedType]: T
+}
+
+export function toJson<T extends Encodable>(value: T): JsonEncoded<T> {
+  const json = JSON.stringify(value)
   if (json === undefined) throw new TypeError('Input not JSONifyable')
-  return json as Json
+  return json as JsonEncoded<T>
 }
-export const fromJson = <T>(json: Json): T => {
+
+export function fromJson<T extends Encodable>(jsonStr: JsonEncoded<T>): T {
   try {
-    return JSON.parse(json) as T
+    return JSON.parse(jsonStr) as T
   } catch (cause) {
     throw new TypeError('Database contains invalid JSON', { cause })
   }
 }
-
-export type JsonArray = `[${string}]`
-export const isJsonArray = (json: string): json is JsonArray =>
-  // Although the JSON in the DB should have been encoded using toJson,
-  // there should not be any leading or trailing whitespace. We will still trim
-  // the string to protect against any manual editing of the DB.
-  json.trimStart().startsWith('[') && json.trimEnd().endsWith(']')
-export function assertJsonArray(json: string): asserts json is JsonArray {
-  if (!isJsonArray(json)) throw new TypeError('Not an Array')
-}
-export const toJsonArray = (obj: readonly unknown[]): JsonArray => {
-  const json = toJson(obj)
-  assertJsonArray(json)
-  return json as JsonArray
-}
-export const fromJsonArray = <T>(json: JsonArray): T[] => {
-  assertJsonArray(json)
-  return fromJson(json) as T[]
-}
-
-export type JsonObject = `{${string}}`
-const isJsonObject = (json: string): json is JsonObject =>
-  // Although the JSON in the DB should have been encoded using toJson,
-  // there should not be any leading or trailing whitespace. We will still trim
-  // the string to protect against any manual editing of the DB.
-  json.trimStart().startsWith('{') && json.trimEnd().endsWith('}')
-function assertJsonObject(json: string): asserts json is JsonObject {
-  if (!isJsonObject(json)) throw new TypeError('Not an Object')
-}
-export const toJsonObject = (
-  obj: Readonly<Record<string, unknown>>,
-): JsonObject => {
-  const json = toJson(obj)
-  assertJsonObject(json)
-  return json as JsonObject
-}
-export const fromJsonObject = <T extends Record<string, unknown>>(
-  json: JsonObject,
-): T => {
-  assertJsonObject(json)
-  return fromJson(json) as T
-}

package/src/lexicon/index.ts

@@ -75,11 +75,13 @@ import * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob.js'
 import * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks.js'
 import * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout.js'
 import * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead.js'
+import * as ComAtprotoSyncGetHostStatus from './types/com/atproto/sync/getHostStatus.js'
 import * as ComAtprotoSyncGetLatestCommit from './types/com/atproto/sync/getLatestCommit.js'
 import * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord.js'
 import * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo.js'
 import * as ComAtprotoSyncGetRepoStatus from './types/com/atproto/sync/getRepoStatus.js'
 import * as ComAtprotoSyncListBlobs from './types/com/atproto/sync/listBlobs.js'
+import * as ComAtprotoSyncListHosts from './types/com/atproto/sync/listHosts.js'
 import * as ComAtprotoSyncListRepos from './types/com/atproto/sync/listRepos.js'
 import * as ComAtprotoSyncListReposByCollection from './types/com/atproto/sync/listReposByCollection.js'
 import * as ComAtprotoSyncNotifyOfUpdate from './types/com/atproto/sync/notifyOfUpdate.js'
@@ -1106,6 +1108,17 @@ export class ComAtprotoSyncNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  getHostStatus<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoSyncGetHostStatus.Handler<ExtractAuth<AV>>,
+      ComAtprotoSyncGetHostStatus.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.sync.getHostStatus' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   getLatestCommit<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,
@@ -1161,6 +1174,17 @@ export class ComAtprotoSyncNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  listHosts<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoSyncListHosts.Handler<ExtractAuth<AV>>,
+      ComAtprotoSyncListHosts.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.sync.listHosts' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   listRepos<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,

package/src/lexicon/lexicons.ts

@@ -3365,6 +3365,16 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoSyncDefs: {
+    lexicon: 1,
+    id: 'com.atproto.sync.defs',
+    defs: {
+      hostStatus: {
+        type: 'string',
+        knownValues: ['active', 'idle', 'offline', 'throttled', 'banned'],
+      },
+    },
+  },
   ComAtprotoSyncGetBlob: {
     lexicon: 1,
     id: 'com.atproto.sync.getBlob',
@@ -3525,6 +3535,59 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoSyncGetHostStatus: {
+    lexicon: 1,
+    id: 'com.atproto.sync.getHostStatus',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Returns information about a specified upstream host, as consumed by the server. Implemented by relays.',
+        parameters: {
+          type: 'params',
+          required: ['hostname'],
+          properties: {
+            hostname: {
+              type: 'string',
+              description:
+                'Hostname of the host (eg, PDS or relay) being queried.',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['hostname'],
+            properties: {
+              hostname: {
+                type: 'string',
+              },
+              seq: {
+                type: 'integer',
+                description:
+                  'Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).',
+              },
+              accountCount: {
+                type: 'integer',
+                description:
+                  'Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts.',
+              },
+              status: {
+                type: 'ref',
+                ref: 'lex:com.atproto.sync.defs#hostStatus',
+              },
+            },
+          },
+        },
+        errors: [
+          {
+            name: 'HostNotFound',
+          },
+        ],
+      },
+    },
+  },
   ComAtprotoSyncGetLatestCommit: {
     lexicon: 1,
     id: 'com.atproto.sync.getLatestCommit',
@@ -3805,6 +3868,74 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoSyncListHosts: {
+    lexicon: 1,
+    id: 'com.atproto.sync.listHosts',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Enumerates upstream hosts (eg, PDS or relay instances) that this service consumes from. Implemented by relays.',
+        parameters: {
+          type: 'params',
+          properties: {
+            limit: {
+              type: 'integer',
+              minimum: 1,
+              maximum: 1000,
+              default: 200,
+            },
+            cursor: {
+              type: 'string',
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['hosts'],
+            properties: {
+              cursor: {
+                type: 'string',
+              },
+              hosts: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:com.atproto.sync.listHosts#host',
+                },
+                description:
+                  'Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first.',
+              },
+            },
+          },
+        },
+      },
+      host: {
+        type: 'object',
+        required: ['hostname'],
+        properties: {
+          hostname: {
+            type: 'string',
+            description: 'hostname of server; not a URL (no scheme)',
+          },
+          seq: {
+            type: 'integer',
+            description:
+              'Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor).',
+          },
+          accountCount: {
+            type: 'integer',
+          },
+          status: {
+            type: 'ref',
+            ref: 'lex:com.atproto.sync.defs#hostStatus',
+          },
+        },
+      },
+    },
+  },
   ComAtprotoSyncListRepos: {
     lexicon: 1,
     id: 'com.atproto.sync.listRepos',
@@ -3992,6 +4123,11 @@ export const schemaDict = {
             },
           },
         },
+        errors: [
+          {
+            name: 'HostBanned',
+          },
+        ],
       },
     },
   },
@@ -10928,7 +11064,7 @@ export const schemaDict = {
               value: {
                 type: 'string',
                 minLength: 1,
-                maxLength: 32,
+                maxLength: 64,
                 minGraphemes: 1,
                 maxGraphemes: 1,
               },
@@ -11714,7 +11850,7 @@ export const schemaDict = {
               value: {
                 type: 'string',
                 minLength: 1,
-                maxLength: 32,
+                maxLength: 64,
                 minGraphemes: 1,
                 maxGraphemes: 1,
               },
@@ -15315,15 +15451,18 @@ export const ids = {
   ComAtprotoServerResetPassword: 'com.atproto.server.resetPassword',
   ComAtprotoServerRevokeAppPassword: 'com.atproto.server.revokeAppPassword',
   ComAtprotoServerUpdateEmail: 'com.atproto.server.updateEmail',
+  ComAtprotoSyncDefs: 'com.atproto.sync.defs',
   ComAtprotoSyncGetBlob: 'com.atproto.sync.getBlob',
   ComAtprotoSyncGetBlocks: 'com.atproto.sync.getBlocks',
   ComAtprotoSyncGetCheckout: 'com.atproto.sync.getCheckout',
   ComAtprotoSyncGetHead: 'com.atproto.sync.getHead',
+  ComAtprotoSyncGetHostStatus: 'com.atproto.sync.getHostStatus',
   ComAtprotoSyncGetLatestCommit: 'com.atproto.sync.getLatestCommit',
   ComAtprotoSyncGetRecord: 'com.atproto.sync.getRecord',
   ComAtprotoSyncGetRepo: 'com.atproto.sync.getRepo',
   ComAtprotoSyncGetRepoStatus: 'com.atproto.sync.getRepoStatus',
   ComAtprotoSyncListBlobs: 'com.atproto.sync.listBlobs',
+  ComAtprotoSyncListHosts: 'com.atproto.sync.listHosts',
   ComAtprotoSyncListRepos: 'com.atproto.sync.listRepos',
   ComAtprotoSyncListReposByCollection: 'com.atproto.sync.listReposByCollection',
   ComAtprotoSyncNotifyOfUpdate: 'com.atproto.sync.notifyOfUpdate',

package/src/lexicon/types/com/atproto/sync/defs.ts

@@ -0,0 +1,23 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'com.atproto.sync.defs'
+
+export type HostStatus =
+  | 'active'
+  | 'idle'
+  | 'offline'
+  | 'throttled'
+  | 'banned'
+  | (string & {})

package/src/lexicon/types/com/atproto/sync/getHostStatus.ts

@@ -0,0 +1,61 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import type * as ComAtprotoSyncDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'com.atproto.sync.getHostStatus'
+
+export interface QueryParams {
+  /** Hostname of the host (eg, PDS or relay) being queried. */
+  hostname: string
+}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  hostname: string
+  /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
+  seq?: number
+  /** Number of accounts on the server which are associated with the upstream host. Note that the upstream may actually have more accounts. */
+  accountCount?: number
+  status?: ComAtprotoSyncDefs.HostStatus
+}
+
+export type HandlerInput = undefined
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+  error?: 'HostNotFound'
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+  resetRouteRateLimits: () => Promise<void>
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput

package/src/lexicon/types/com/atproto/sync/listHosts.ts

@@ -0,0 +1,77 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import { HandlerAuth, HandlerPipeThrough } from '@atproto/xrpc-server'
+import type * as ComAtprotoSyncDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'com.atproto.sync.listHosts'
+
+export interface QueryParams {
+  limit: number
+  cursor?: string
+}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  cursor?: string
+  /** Sort order is not formally specified. Recommended order is by time host was first seen by the server, with oldest first. */
+  hosts: Host[]
+}
+
+export type HandlerInput = undefined
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess | HandlerPipeThrough
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+  resetRouteRateLimits: () => Promise<void>
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput
+
+export interface Host {
+  $type?: 'com.atproto.sync.listHosts#host'
+  /** hostname of server; not a URL (no scheme) */
+  hostname: string
+  /** Recent repo stream event sequence number. May be delayed from actual stream processing (eg, persisted cursor not in-memory cursor). */
+  seq?: number
+  accountCount?: number
+  status?: ComAtprotoSyncDefs.HostStatus
+}
+
+const hashHost = 'host'
+
+export function isHost<V>(v: V) {
+  return is$typed(v, id, hashHost)
+}
+
+export function validateHost<V>(v: V) {
+  return validate<Host & V>(v, id, hashHost)
+}

package/src/lexicon/types/com/atproto/sync/requestCrawl.ts

@@ -31,6 +31,7 @@ export interface HandlerInput {
 export interface HandlerError {
   status: number
   message?: string
+  error?: 'HostBanned'
 }
 
 export type HandlerOutput = HandlerError | void

package/src/mailer/templates/plc-operation.hbs

@@ -6,12 +6,12 @@
     <title>PLC update requested</title>
     <meta
       name="description"
-      content="We recieved a request to update your PLC."
+      content="We received a request to update your PLC."
     />
   </head>
   <div
     style="display:none;overflow:hidden;line-height:1px;opacity:0;max-height:0;max-width:0"
-  >We recieved a request to update your PLC.<div
+  >We received a request to update your PLC.<div
     > ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏</div>
   </div>
 

package/tests/db.test.ts

@@ -1,5 +1,6 @@
 import { TestNetworkNoAppView } from '@atproto/dev-env'
-import { AccountDb } from '../src/account-manager/db'
+// Importing from `dist` to circumvent circular dependency typing issues
+import { AccountDb } from '../dist/account-manager/db'
 
 describe('db', () => {
   let network: TestNetworkNoAppView