@atproto/pds 0.5.12 → 0.5.15

package/src/image/image-url-builder.ts

@@ -1,16 +0,0 @@
-import { BskyAppView } from '../bsky-app-view.js'
-import { com } from '../lexicons/index.js'
-
-export class ImageUrlBuilder {
-  constructor(
-    readonly pdsHostname: string,
-    readonly bskyAppView?: BskyAppView,
-  ) {}
-
-  build(pattern: string, did: string, cid: string): string {
-    return (
-      this.bskyAppView?.getImageUrl(pattern, did, cid) ??
-      `https://${this.pdsHostname}/xrpc/${com.atproto.sync.getBlob.$lxm}?did=${did}&cid=${cid}`
-    )
-  }
-}

package/src/index.ts

@@ -1,189 +0,0 @@
-// catch errors that get thrown in async route handlers
-// this is a relatively non-invasive change to express
-// they get handled in the error.handler middleware
-// leave at top of file before importing Routes
-import 'express-async-errors'
-
-import events from 'node:events'
-import http from 'node:http'
-import { PlcClientError } from '@did-plc/lib'
-import cors from 'cors'
-import express from 'express'
-// eslint-disable-next-line import/default
-import httpTerminator from 'http-terminator'
-import { DAY, SECOND } from '@atproto/common'
-import {
-  MethodHandler,
-  ResponseType,
-  XRPCError,
-  createServer,
-} from '@atproto/xrpc-server'
-import apiRoutes from './api/index.js'
-import * as authRoutes from './auth-routes.js'
-import * as basicRoutes from './basic-routes.js'
-import { ServerConfig, ServerSecrets } from './config/index.js'
-import { AppContext, AppContextOptions } from './context.js'
-import * as error from './error.js'
-import { app } from './lexicons.js'
-import { loggerMiddleware } from './logger.js'
-import { proxyHandler } from './pipethrough.js'
-import { buildRateLimitsConfig } from './rate-limits.js'
-import compression from './util/compression.js'
-import * as wellKnown from './well-known.js'
-
-export * from './lexicons.js'
-export {
-  bearerTokenFromReq,
-  createPublicKeyObject,
-  createSecretKeyObject,
-} from './auth-verifier.js'
-export * from './config/index.js'
-export { AppContext } from './context.js'
-export { Database } from './db/index.js'
-export { DiskBlobStore } from './disk-blobstore.js'
-export { httpLogger } from './logger.js'
-export { type CommitDataWithOps, type PreparedWrite } from './repo/index.js'
-export * as repoPrepare from './repo/prepare.js'
-export { scripts } from './scripts/index.js'
-export * as sequencer from './sequencer/index.js'
-
-/**
- * @deprecated Legacy export for backwards compatibility
- */
-export type SkeletonHandler = MethodHandler<
-  void,
-  app.bsky.feed.getFeedSkeleton.$Params,
-  void,
-  app.bsky.feed.getFeedSkeleton.$Output
->
-
-export class PDS {
-  public ctx: AppContext
-  public app: express.Application
-  public server?: http.Server
-  private terminator?: httpTerminator.HttpTerminator
-  private dbStatsInterval?: NodeJS.Timeout
-  private sequencerStatsInterval?: NodeJS.Timeout
-
-  constructor(opts: { ctx: AppContext; app: express.Application }) {
-    this.ctx = opts.ctx
-    this.app = opts.app
-  }
-
-  static async create(
-    cfg: ServerConfig,
-    secrets: ServerSecrets,
-    overrides?: Partial<AppContextOptions>,
-  ): Promise<PDS> {
-    const ctx = await AppContext.fromConfig(cfg, secrets, overrides)
-
-    const { rateLimits } = ctx.cfg
-
-    const server = createServer([], {
-      validateResponse: cfg.service.devMode,
-      payload: {
-        jsonLimit: 150 * 1024, // 150kb
-        textLimit: 100 * 1024, // 100kb
-        blobLimit: cfg.service.blobUploadLimit,
-      },
-      catchall: proxyHandler(ctx),
-      errorParser: (err) => {
-        if (err instanceof PlcClientError) {
-          const payloadMessage =
-            typeof err.data === 'object' &&
-            err.data != null &&
-            'message' in err.data &&
-            typeof err.data.message === 'string' &&
-            err.data.message
-
-          const type =
-            err.status >= 500
-              ? ResponseType.UpstreamFailure
-              : ResponseType.InvalidRequest
-
-          return new XRPCError(
-            type,
-            payloadMessage || 'Unable to perform PLC operation',
-          )
-        }
-
-        return XRPCError.fromError(err)
-      },
-      rateLimits: buildRateLimitsConfig(rateLimits, ctx.redisScratch),
-    })
-
-    apiRoutes(server, ctx)
-
-    const app = express()
-    app.set('trust proxy', [
-      // e.g. load balancer
-      'loopback',
-      'linklocal',
-      'uniquelocal',
-      // e.g. trust x-forwarded-for via entryway ip
-      ...getTrustedIps(cfg),
-    ])
-    app.use(loggerMiddleware)
-    app.use(compression())
-    app.use(authRoutes.createRouter(ctx)) // Before CORS
-    app.use(cors({ maxAge: DAY / SECOND }))
-    app.use(basicRoutes.createRouter(ctx))
-    app.use(wellKnown.createRouter(ctx))
-    app.use(server.router)
-    app.use(error.handler)
-
-    return new PDS({
-      ctx,
-      app,
-    })
-  }
-
-  async start(): Promise<http.Server> {
-    await this.ctx.sequencer.start()
-    const server = this.app.listen(this.ctx.cfg.service.port)
-    this.server = server
-    this.server.keepAliveTimeout = 90_000
-    this.terminator = httpTerminator.createHttpTerminator({ server })
-    await events.once(server, 'listening')
-    return server
-  }
-
-  async destroy(): Promise<void> {
-    clearInterval(this.dbStatsInterval)
-    clearInterval(this.sequencerStatsInterval)
-
-    // @TODO Use disposable stack when it becomes available (Node24+)
-    try {
-      await this.terminator?.terminate()
-    } finally {
-      try {
-        await this.ctx.backgroundQueue.destroy()
-      } finally {
-        try {
-          await this.ctx.sequencer.destroy()
-        } finally {
-          try {
-            await this.ctx.accountManager.close()
-          } finally {
-            try {
-              await this.ctx.redisScratch?.quit()
-            } finally {
-              await this.ctx.proxyAgent.destroy()
-            }
-          }
-        }
-      }
-    }
-  }
-
-  async [Symbol.asyncDispose]() {
-    await this.destroy()
-  }
-}
-
-export default PDS
-
-const getTrustedIps = (cfg: ServerConfig) => {
-  if (!cfg.rateLimits.enabled) return []
-  return cfg.rateLimits.bypassIps ?? []
-}

package/src/lexicons.ts

@@ -1,4 +0,0 @@
-export * as com from './lexicons/com.js'
-export * as app from './lexicons/app.js'
-export * as chat from './lexicons/chat.js'
-export * as tools from './lexicons/tools.js'

package/src/logger.ts

@@ -1,35 +0,0 @@
-import { type IncomingMessage } from 'node:http'
-import { stdSerializers } from 'pino'
-import { pinoHttp } from 'pino-http'
-import { obfuscateHeaders, subsystemLogger } from '@atproto/common'
-
-export const blobStoreLogger = subsystemLogger('pds:blob-store')
-export const dbLogger = subsystemLogger('pds:db')
-export const didCacheLogger = subsystemLogger('pds:did-cache')
-export const readStickyLogger = subsystemLogger('pds:read-sticky')
-export const redisLogger = subsystemLogger('pds:redis')
-export const seqLogger = subsystemLogger('pds:sequencer')
-export const mailerLogger = subsystemLogger('pds:mailer')
-export const labelerLogger = subsystemLogger('pds:labeler')
-export const crawlerLogger = subsystemLogger('pds:crawler')
-export const httpLogger = subsystemLogger('pds')
-export const fetchLogger = subsystemLogger('pds:fetch')
-export const oauthLogger = subsystemLogger('pds:oauth')
-export const lexiconResolverLogger = subsystemLogger('pds:lexicon-resolver')
-
-export const loggerMiddleware = pinoHttp({
-  logger: httpLogger,
-  serializers: {
-    req: reqSerializer,
-    err: (err: unknown) => ({
-      code: err?.['code'],
-      message: err?.['message'],
-    }),
-  },
-})
-
-export function reqSerializer(req: IncomingMessage) {
-  const serialized = stdSerializers.req(req)
-  const headers = obfuscateHeaders(serialized.headers)
-  return { ...serialized, headers }
-}

package/src/mailer/index.ts

@@ -1,111 +0,0 @@
-import { SendMailOptions, Transporter } from 'nodemailer'
-import { htmlToText } from 'nodemailer-html-to-text'
-import { BrandingConfig, EmailConfig } from '../config/index.js'
-import { mailerLogger } from '../logger.js'
-import * as templates from './templates.js'
-
-// @TODO Add support for i18n
-
-const DEFAULT_LOGO_URL =
-  'https://bsky.social/about/images/email/email_logo_default.png'
-const DEFAULT_MARK_URL =
-  'https://bsky.social/about/images/email/email_mark_dark.png'
-const DEFAULT_HOME_URL = 'https://bsky.app'
-const DEFAULT_PRIMARY_COLOR = '#067df7'
-
-export class ServerMailer {
-  private readonly config: templates.Config
-
-  constructor(
-    public readonly transporter: Transporter,
-    private readonly email: EmailConfig | null,
-    branding: BrandingConfig,
-  ) {
-    transporter.use('compile', htmlToText())
-
-    this.config = {
-      serviceName: branding.name ?? 'Bluesky',
-      homeUrl:
-        branding.links?.find((link) => link.rel === 'canonical')?.href ??
-        DEFAULT_HOME_URL,
-      logoUrl: branding.logo ?? DEFAULT_LOGO_URL,
-      markUrl: branding.logo ?? DEFAULT_MARK_URL,
-      primaryColor: branding.colors?.primary ?? DEFAULT_PRIMARY_COLOR,
-      showBskyAppEmailConfirmationLink: email?.disableConfirmationLink !== true,
-    }
-  }
-
-  async sendResetPassword(
-    params: { handle: string; token: string; locale?: string },
-    mailOpts: SendMailOptions,
-  ) {
-    // @TODO (later) handle locale in the template
-    await this.sendTemplate('resetPassword', params, {
-      subject: 'Password Reset Requested',
-      ...mailOpts,
-    })
-  }
-
-  async sendAccountDelete(
-    params: { token: string; locale?: string },
-    mailOpts: SendMailOptions,
-  ) {
-    // @TODO (later) handle locale in the template
-    await this.sendTemplate('deleteAccount', params, {
-      subject: 'Account Deletion Requested',
-      ...mailOpts,
-    })
-  }
-
-  async sendConfirmEmail(
-    params: { token: string; locale?: string },
-    mailOpts: SendMailOptions,
-  ) {
-    // @TODO (later) handle locale in the template
-    await this.sendTemplate('confirmEmail', params, {
-      subject: 'Email Confirmation',
-      ...mailOpts,
-    })
-  }
-
-  async sendUpdateEmail(
-    params: { token: string; locale?: string },
-    mailOpts: SendMailOptions,
-  ) {
-    // @TODO (later) handle locale in the template
-    await this.sendTemplate('updateEmail', params, {
-      subject: 'Email Update Requested',
-      ...mailOpts,
-    })
-  }
-
-  async sendPlcOperation(params: { token: string }, mailOpts: SendMailOptions) {
-    await this.sendTemplate('plcOperation', params, {
-      subject: 'PLC Update Operation Requested',
-      ...mailOpts,
-    })
-  }
-
-  private async sendTemplate<K extends keyof typeof templates>(
-    templateName: K,
-    params: Parameters<(typeof templates)[K]>[0],
-    mailOpts: SendMailOptions,
-  ) {
-    const html = templates[templateName]({
-      ...params,
-      config: this.config,
-    } as any)
-    const res = await this.transporter.sendMail({
-      ...mailOpts,
-      from: mailOpts.from ?? this.email?.fromAddress,
-      html,
-    })
-    if (!this.email?.smtpUrl) {
-      mailerLogger.debug(
-        'No SMTP URL has been configured. Intended to send email:\n' +
-          JSON.stringify(res, null, 2),
-      )
-    }
-    return res
-  }
-}

package/src/mailer/moderation.ts

@@ -1,33 +0,0 @@
-import { SendMailOptions, Transporter } from 'nodemailer'
-import { htmlToText } from 'nodemailer-html-to-text'
-import { ServerConfig } from '../config/index.js'
-import { mailerLogger } from '../logger.js'
-
-export class ModerationMailer {
-  private config: ServerConfig
-  transporter: Transporter
-
-  constructor(transporter: Transporter, config: ServerConfig) {
-    this.config = config
-    this.transporter = transporter
-    this.transporter.use('compile', htmlToText())
-  }
-
-  async send({ content }: { content: string }, mailOpts: SendMailOptions) {
-    const mail = {
-      ...mailOpts,
-      html: content,
-      from: this.config.moderationEmail?.fromAddress,
-    }
-
-    const res = await this.transporter.sendMail(mail)
-
-    if (!this.config.moderationEmail?.smtpUrl) {
-      mailerLogger.debug(
-        'Moderation email auth is not configured. Intended to send email:\n' +
-          JSON.stringify(res, null, 2),
-      )
-    }
-    return res
-  }
-}

package/src/mailer/templates/confirm-email.d.ts

@@ -1,4 +0,0 @@
-import { TemplateDelegate } from 'handlebars'
-
-declare const template: TemplateDelegate<{ token: string }>
-export default template

package/src/mailer/templates/confirm-email.hbs

@@ -1,158 +0,0 @@
-<html dir="ltr" lang="en">
-
-  <head>
-    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
-    <meta name="x-apple-disable-message-reformatting" />
-    <title>Confirm your email</title>
-    <meta name="description" content="{{token}} is your verification code." />
-  </head>
-  <div
-    style="display:none;overflow:hidden;line-height:1px;opacity:0;max-height:0;max-width:0"
-  >{{token}}
-    is your verification code.<div
-    > ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏ ‌​‍‎‏</div>
-  </div>
-
-  <body
-    style="padding:12px;padding-bottom:40px;background-color:hsl(211, 20%, 95.3%)"
-  >
-    <table
-      align="center"
-      width="100%"
-      border="0"
-      cellPadding="0"
-      cellSpacing="0"
-      role="presentation"
-      style="max-width:37.5em"
-    >
-      <tbody>
-        <tr style="width:100%">
-          <td>
-            <table
-              align="center"
-              width="100%"
-              border="0"
-              cellPadding="0"
-              cellSpacing="0"
-              role="presentation"
-              style="padding-top:24px;padding-bottom:24px"
-            >
-              <tbody>
-                <tr>
-                  <td><img
-                      alt="{{config.serviceName}}"
-                      src="{{config.logoUrl}}"
-                      style="display:block;outline:none;border:none;text-decoration:none;width:110px;margin:0 auto"
-                    /></td>
-                </tr>
-              </tbody>
-            </table>
-            <table
-              align="center"
-              width="100%"
-              border="0"
-              cellPadding="0"
-              cellSpacing="0"
-              role="presentation"
-              style="padding:24px;padding-bottom:16px;border-radius:12px;background-color:#FFFFFF"
-            >
-              <tbody>
-                <tr>
-                  <td>
-                    <h1
-                      style="font-size:26px;letter-spacing:0.25px;color:#000000;font-family:-apple-system, BlinkMacSystemFont, &#x27;Roboto&#x27;, &#x27;Oxygen&#x27;, &#x27;Ubuntu&#x27;, &#x27;Cantarell&#x27;, &#x27;Fira Sans&#x27;, &#x27;Droid Sans&#x27;, &#x27;Helvetica Neue&#x27;, sans-serif;margin:0px 0px;line-height:1.0"
-                    >Confirm your email</h1>
-                    <p
-                      style="font-size:16px;line-height:1.4;margin:0px 0px;letter-spacing:0.25px;color:hsl(211, 24%, 34.2%);font-family:-apple-system, BlinkMacSystemFont, &#x27;Roboto&#x27;, &#x27;Oxygen&#x27;, &#x27;Ubuntu&#x27;, &#x27;Cantarell&#x27;, &#x27;Fira Sans&#x27;, &#x27;Droid Sans&#x27;, &#x27;Helvetica Neue&#x27;, sans-serif;padding-top:12px;padding-bottom:12px;padding-right:32px"
-                    >To confirm this email for your account, please enter the
-                      code below in the app{{#if
-                        config.showBskyAppEmailConfirmationLink
-                      }}
-                        or<!-- -->
-                        <a
-                          href="https://bsky.app/intent/verify-email?code={{token}}"
-                          style="color:{{config.primaryColor}};text-decoration:none;text-decoration-line:underline;font-size:16px;letter-spacing:0.25px"
-                          target="_blank"
-                        >click here</a>{{/if}}.</p><code
-                      style="display:block;padding:16px;border-radius:8px;border-width:1px;border-style:solid;background-color:hsl(211, 20%, 95.3%);border-color:hsl(211, 20%, 85.89999999999999%);font-size:14px;letter-spacing:0.25px;font-family:monospace;text-transform:uppercase"
-                    >{{token}}</code>
-                    <p
-                      style="font-size:14px;line-height:1.4;margin:0px 0px;letter-spacing:0.25px;color:hsl(211, 20%, 53%);font-family:-apple-system, BlinkMacSystemFont, &#x27;Roboto&#x27;, &#x27;Oxygen&#x27;, &#x27;Ubuntu&#x27;, &#x27;Cantarell&#x27;, &#x27;Fira Sans&#x27;, &#x27;Droid Sans&#x27;, &#x27;Helvetica Neue&#x27;, sans-serif;padding-top:12px"
-                    >If you didn&#x27;t request an email confirmation, you can
-                      safely ignore this email.</p>
-                    <table
-                      align="center"
-                      width="100%"
-                      border="0"
-                      cellPadding="0"
-                      cellSpacing="0"
-                      role="presentation"
-                      style="padding-top:24px"
-                    >
-                      <tbody>
-                        <tr>
-                          <td>
-                            <hr
-                              style="width:100%;border:none;border-top:1px solid #eaeaea;margin:0"
-                            />
-                            <table
-                              align="center"
-                              width="100%"
-                              border="0"
-                              cellPadding="0"
-                              cellSpacing="0"
-                              role="presentation"
-                              style="padding-top:16px;vertical-align:middle"
-                            >
-                              <tbody style="width:100%">
-                                <tr style="width:100%">
-                                  <td data-id="__react-email-column">
-                                    <p
-                                      style="font-size:14px;line-height:1.4;margin:0px 0px;color:hsl(211, 20%, 53%);font-family:-apple-system, BlinkMacSystemFont, &#x27;Roboto&#x27;, &#x27;Oxygen&#x27;, &#x27;Ubuntu&#x27;, &#x27;Cantarell&#x27;, &#x27;Fira Sans&#x27;, &#x27;Droid Sans&#x27;, &#x27;Helvetica Neue&#x27;, sans-serif;letter-spacing:0.25px"
-                                    ><a
-                                        href="{{config.homeUrl}}"
-                                        style="color:hsl(211, 20%, 53%);text-decoration:none;text-decoration-line:underline;font-family:-apple-system, BlinkMacSystemFont, &#x27;Roboto&#x27;, &#x27;Oxygen&#x27;, &#x27;Ubuntu&#x27;, &#x27;Cantarell&#x27;, &#x27;Fira Sans&#x27;, &#x27;Droid Sans&#x27;, &#x27;Helvetica Neue&#x27;, sans-serif;margin:0px 0px;line-height:1.0;font-size:14px;letter-spacing:0.25px"
-                                        target="_blank"
-                                      >{{config.serviceName}}</a></p>
-                                  </td>
-                                  <td
-                                    data-id="__react-email-column"
-                                    style="width:24px"
-                                  ><img
-                                      alt="{{config.serviceName}}"
-                                      src="{{config.markUrl}}"
-                                      style="display:block;outline:none;border:none;text-decoration:none;width:24px"
-                                    /></td>
-                                </tr>
-                              </tbody>
-                            </table>
-                          </td>
-                        </tr>
-                      </tbody>
-                    </table>
-                  </td>
-                </tr>
-              </tbody>
-            </table>
-            <table
-              align="center"
-              width="100%"
-              border="0"
-              cellPadding="0"
-              cellSpacing="0"
-              role="presentation"
-              style="height:500px"
-            >
-              <tbody>
-                <tr>
-                  <td></td>
-                </tr>
-              </tbody>
-            </table>
-          </td>
-        </tr>
-      </tbody>
-    </table>
-  </body>
-
-</html>

package/src/mailer/templates/delete-account.d.ts

@@ -1,4 +0,0 @@
-import { TemplateDelegate } from 'handlebars'
-
-declare const template: TemplateDelegate<{ token: string }>
-export default template