@atproto/ozone 0.0.2 → 0.0.5

package/src/api/admin/updateCommunicationTemplate.ts

@@ -0,0 +1,40 @@
+import { AuthRequiredError, InvalidRequestError } from '@atproto/xrpc-server'
+import { Server } from '../../lexicon'
+import AppContext from '../../context'
+
+export default function (server: Server, ctx: AppContext) {
+  server.com.atproto.admin.updateCommunicationTemplate({
+    auth: ctx.roleVerifier,
+    handler: async ({ input, auth }) => {
+      const access = auth.credentials
+      const db = ctx.db
+      const { id, updatedBy, ...template } = input.body
+
+      if (!access.admin) {
+        throw new AuthRequiredError(
+          'Must be an admin to update a communication template',
+        )
+      }
+
+      // Once auth starts providing us with the caller's DID, we can get rid of this check
+      if (!updatedBy) {
+        throw new InvalidRequestError('updatedBy field is required')
+      }
+
+      if (!Object.keys(template).length) {
+        throw new InvalidRequestError('Missing update data in request body')
+      }
+
+      const communicationTemplate = ctx.communicationTemplateService(db)
+      const updatedTemplate = await communicationTemplate.update(Number(id), {
+        ...template,
+        lastUpdatedBy: updatedBy,
+      })
+
+      return {
+        encoding: 'application/json',
+        body: communicationTemplate.view(updatedTemplate),
+      }
+    },
+  })
+}

package/src/api/index.ts

@@ -9,6 +9,10 @@ import queryModerationStatuses from './admin/queryModerationStatuses'
 import queryModerationEvents from './admin/queryModerationEvents'
 import getModerationEvent from './admin/getModerationEvent'
 import fetchLabels from './temp/fetchLabels'
+import createCommunicationTemplate from './admin/createCommunicationTemplate'
+import updateCommunicationTemplate from './admin/updateCommunicationTemplate'
+import deleteCommunicationTemplate from './admin/deleteCommunicationTemplate'
+import listCommunicationTemplates from './admin/listCommunicationTemplates'
 
 export * as health from './health'
 
@@ -24,5 +28,9 @@ export default function (server: Server, ctx: AppContext) {
   queryModerationEvents(server, ctx)
   queryModerationStatuses(server, ctx)
   fetchLabels(server, ctx)
+  listCommunicationTemplates(server, ctx)
+  createCommunicationTemplate(server, ctx)
+  updateCommunicationTemplate(server, ctx)
+  deleteCommunicationTemplate(server, ctx)
   return server
 }

package/src/communication-service/template.ts

@@ -0,0 +1,105 @@
+import Database from '../db'
+import { Selectable } from 'kysely'
+import { CommunicationTemplate } from '../db/schema/communication_template'
+import { CommunicationTemplateView } from '../lexicon/types/com/atproto/admin/defs'
+
+export type CommunicationTemplateServiceCreator = (
+  db: Database,
+) => CommunicationTemplateService
+
+export class CommunicationTemplateService {
+  constructor(public db: Database) {}
+
+  static creator() {
+    return (db: Database) => new CommunicationTemplateService(db)
+  }
+
+  async list(): Promise<Selectable<CommunicationTemplate>[]> {
+    const list = await this.db.db
+      .selectFrom('communication_template')
+      .selectAll()
+      .execute()
+
+    return list
+  }
+
+  async create({
+    name,
+    contentMarkdown,
+    subject,
+    disabled,
+    updatedAt,
+    createdAt,
+    lastUpdatedBy,
+  }: Omit<
+    Selectable<CommunicationTemplate>,
+    'id' | 'createdAt' | 'updatedAt'
+  > & {
+    createdAt?: Date
+    updatedAt?: Date
+  }): Promise<Selectable<CommunicationTemplate>> {
+    const newTemplate = await this.db.db
+      .insertInto('communication_template')
+      .values({
+        name,
+        contentMarkdown,
+        subject,
+        disabled,
+        lastUpdatedBy,
+        updatedAt: updatedAt || new Date(),
+        createdAt: createdAt || new Date(),
+      })
+      .returningAll()
+      .executeTakeFirstOrThrow()
+
+    return newTemplate
+  }
+
+  async update(
+    id: number,
+    {
+      name,
+      contentMarkdown,
+      subject,
+      disabled,
+      updatedAt,
+      lastUpdatedBy,
+    }: Partial<Omit<Selectable<CommunicationTemplate>, 'id' | 'createdAt'>>,
+  ): Promise<Selectable<CommunicationTemplate>> {
+    const updatedTemplate = await this.db.db
+      .updateTable('communication_template')
+      .where('id', '=', id)
+      .set({
+        name,
+        contentMarkdown,
+        subject,
+        disabled,
+        lastUpdatedBy,
+        updatedAt: updatedAt || new Date(),
+      })
+      .returningAll()
+      .executeTakeFirstOrThrow()
+
+    return updatedTemplate
+  }
+
+  async delete(id: number): Promise<void> {
+    await this.db.db
+      .deleteFrom('communication_template')
+      .where('id', '=', id)
+      .execute()
+  }
+
+  view(template: Selectable<CommunicationTemplate>): CommunicationTemplateView {
+    return {
+      id: `${template.id}`,
+      name: template.name,
+      contentMarkdown: template.contentMarkdown,
+      disabled: template.disabled,
+      subject: template.subject || undefined,
+      createdAt: template.createdAt.toISOString(),
+      updatedAt: template.updatedAt.toISOString(),
+      lastUpdatedBy: template.lastUpdatedBy,
+    }
+  }
+}

package/src/context.ts

@@ -10,11 +10,16 @@ import * as auth from './auth'
 import { BackgroundQueue } from './background'
 import assert from 'assert'
 import { EventPusher } from './daemon'
+import {
+  CommunicationTemplateService,
+  CommunicationTemplateServiceCreator,
+} from './communication-service/template'
 
 export type AppContextOptions = {
   db: Database
   cfg: OzoneConfig
   modService: ModerationServiceCreator
+  communicationTemplateService: CommunicationTemplateServiceCreator
   appviewAgent: AtpAgent
   pdsAgent: AtpAgent | undefined
   signingKey: Keypair
@@ -62,6 +67,8 @@ export class AppContext {
       appviewAuth,
     )
 
+    const communicationTemplateService = CommunicationTemplateService.creator()
+
     const idResolver = new IdResolver({
       plcUrl: cfg.identity.plcUrl,
     })
@@ -71,6 +78,7 @@ export class AppContext {
         db,
         cfg,
         modService,
+        communicationTemplateService,
         appviewAgent,
         pdsAgent,
         signingKey,
@@ -102,6 +110,10 @@ export class AppContext {
     return this.opts.modService
   }
 
+  get communicationTemplateService(): CommunicationTemplateServiceCreator {
+    return this.opts.communicationTemplateService
+  }
+
   get appviewAgent(): AtpAgent {
     return this.opts.appviewAgent
   }

package/src/db/migrations/20240116T085607200Z-communication-template.ts

@@ -0,0 +1,23 @@
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .createTable('communication_template')
+    .addColumn('id', 'serial', (col) => col.primaryKey())
+    .addColumn('name', 'varchar', (col) => col.notNull())
+    .addColumn('contentMarkdown', 'varchar', (col) => col.notNull())
+    .addColumn('subject', 'varchar')
+    .addColumn('disabled', 'boolean', (col) => col.defaultTo(false).notNull())
+    .addColumn('createdAt', 'timestamptz')
+    .addColumn('updatedAt', 'timestamptz')
+    .addColumn('lastUpdatedBy', 'varchar', (col) => col.notNull())
+    .addUniqueConstraint('communication_template_unique_name', [
+      'name',
+      'disabled',
+    ])
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema.dropTable('communication_template')
+}

package/src/db/migrations/index.ts

@@ -3,3 +3,4 @@
 // this with kysely's FileMigrationProvider, but it doesn't play nicely with the build process.
 
 export * as _20231219T205730722Z from './20231219T205730722Z-init'
+export * as _20240116T085607200Z from './20240116T085607200Z-communication-template'

package/src/db/schema/communication_template.ts

@@ -0,0 +1,18 @@
+import { Generated, GeneratedAlways } from 'kysely'
+
+export const communicationTemplateTableName = 'communication_template'
+
+export interface CommunicationTemplate {
+  id: GeneratedAlways<number>
+  name: string
+  contentMarkdown: string
+  subject: string | null
+  disabled: Generated<boolean>
+  createdAt: Date
+  updatedAt: Date
+  lastUpdatedBy: string
+}
+
+export type PartialDB = {
+  [communicationTemplateTableName]: CommunicationTemplate
+}

package/src/db/schema/index.ts

@@ -5,13 +5,15 @@ import * as repoPushEvent from './repo_push_event'
 import * as recordPushEvent from './record_push_event'
 import * as blobPushEvent from './blob_push_event'
 import * as label from './label'
+import * as communicationTemplate from './communication_template'
 
 export type DatabaseSchemaType = modEvent.PartialDB &
   modSubjectStatus.PartialDB &
   label.PartialDB &
   repoPushEvent.PartialDB &
   recordPushEvent.PartialDB &
-  blobPushEvent.PartialDB
+  blobPushEvent.PartialDB &
+  communicationTemplate.PartialDB
 
 export type DatabaseSchema = Kysely<DatabaseSchemaType>
 

package/src/lexicon/index.ts

@@ -9,7 +9,9 @@ import {
   StreamAuthVerifier,
 } from '@atproto/xrpc-server'
 import { schemas } from './lexicons'
+import * as ComAtprotoAdminCreateCommunicationTemplate from './types/com/atproto/admin/createCommunicationTemplate'
 import * as ComAtprotoAdminDeleteAccount from './types/com/atproto/admin/deleteAccount'
+import * as ComAtprotoAdminDeleteCommunicationTemplate from './types/com/atproto/admin/deleteCommunicationTemplate'
 import * as ComAtprotoAdminDisableAccountInvites from './types/com/atproto/admin/disableAccountInvites'
 import * as ComAtprotoAdminDisableInviteCodes from './types/com/atproto/admin/disableInviteCodes'
 import * as ComAtprotoAdminEmitModerationEvent from './types/com/atproto/admin/emitModerationEvent'
@@ -21,12 +23,14 @@ import * as ComAtprotoAdminGetModerationEvent from './types/com/atproto/admin/ge
 import * as ComAtprotoAdminGetRecord from './types/com/atproto/admin/getRecord'
 import * as ComAtprotoAdminGetRepo from './types/com/atproto/admin/getRepo'
 import * as ComAtprotoAdminGetSubjectStatus from './types/com/atproto/admin/getSubjectStatus'
+import * as ComAtprotoAdminListCommunicationTemplates from './types/com/atproto/admin/listCommunicationTemplates'
 import * as ComAtprotoAdminQueryModerationEvents from './types/com/atproto/admin/queryModerationEvents'
 import * as ComAtprotoAdminQueryModerationStatuses from './types/com/atproto/admin/queryModerationStatuses'
 import * as ComAtprotoAdminSearchRepos from './types/com/atproto/admin/searchRepos'
 import * as ComAtprotoAdminSendEmail from './types/com/atproto/admin/sendEmail'
 import * as ComAtprotoAdminUpdateAccountEmail from './types/com/atproto/admin/updateAccountEmail'
 import * as ComAtprotoAdminUpdateAccountHandle from './types/com/atproto/admin/updateAccountHandle'
+import * as ComAtprotoAdminUpdateCommunicationTemplate from './types/com/atproto/admin/updateCommunicationTemplate'
 import * as ComAtprotoAdminUpdateSubjectStatus from './types/com/atproto/admin/updateSubjectStatus'
 import * as ComAtprotoIdentityResolveHandle from './types/com/atproto/identity/resolveHandle'
 import * as ComAtprotoIdentityUpdateHandle from './types/com/atproto/identity/updateHandle'
@@ -120,6 +124,7 @@ import * as AppBskyNotificationListNotifications from './types/app/bsky/notifica
 import * as AppBskyNotificationRegisterPush from './types/app/bsky/notification/registerPush'
 import * as AppBskyNotificationUpdateSeen from './types/app/bsky/notification/updateSeen'
 import * as AppBskyUnspeccedGetPopularFeedGenerators from './types/app/bsky/unspecced/getPopularFeedGenerators'
+import * as AppBskyUnspeccedGetTaggedSuggestions from './types/app/bsky/unspecced/getTaggedSuggestions'
 import * as AppBskyUnspeccedGetTimelineSkeleton from './types/app/bsky/unspecced/getTimelineSkeleton'
 import * as AppBskyUnspeccedSearchActorsSkeleton from './types/app/bsky/unspecced/searchActorsSkeleton'
 import * as AppBskyUnspeccedSearchPostsSkeleton from './types/app/bsky/unspecced/searchPostsSkeleton'
@@ -200,6 +205,17 @@ export class ComAtprotoAdminNS {
     this._server = server
   }
 
+  createCommunicationTemplate<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoAdminCreateCommunicationTemplate.Handler<ExtractAuth<AV>>,
+      ComAtprotoAdminCreateCommunicationTemplate.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.admin.createCommunicationTemplate' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   deleteAccount<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,
@@ -211,6 +227,17 @@ export class ComAtprotoAdminNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  deleteCommunicationTemplate<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoAdminDeleteCommunicationTemplate.Handler<ExtractAuth<AV>>,
+      ComAtprotoAdminDeleteCommunicationTemplate.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.admin.deleteCommunicationTemplate' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   disableAccountInvites<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,
@@ -332,6 +359,17 @@ export class ComAtprotoAdminNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  listCommunicationTemplates<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoAdminListCommunicationTemplates.Handler<ExtractAuth<AV>>,
+      ComAtprotoAdminListCommunicationTemplates.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.admin.listCommunicationTemplates' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   queryModerationEvents<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,
@@ -398,6 +436,17 @@ export class ComAtprotoAdminNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  updateCommunicationTemplate<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoAdminUpdateCommunicationTemplate.Handler<ExtractAuth<AV>>,
+      ComAtprotoAdminUpdateCommunicationTemplate.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.admin.updateCommunicationTemplate' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   updateSubjectStatus<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,
@@ -1565,6 +1614,17 @@ export class AppBskyUnspeccedNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  getTaggedSuggestions<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      AppBskyUnspeccedGetTaggedSuggestions.Handler<ExtractAuth<AV>>,
+      AppBskyUnspeccedGetTaggedSuggestions.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'app.bsky.unspecced.getTaggedSuggestions' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   getTimelineSkeleton<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,