@atproto/ozone 0.0.2 → 0.0.4

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'
@@ -200,6 +204,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 +226,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 +358,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 +435,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,

package/src/lexicon/lexicons.ts

@@ -4,6 +4,51 @@
 import { LexiconDoc, Lexicons } from '@atproto/lexicon'
 
 export const schemaDict = {
+  ComAtprotoAdminCreateCommunicationTemplate: {
+    lexicon: 1,
+    id: 'com.atproto.admin.createCommunicationTemplate',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Administrative action to create a new, re-usable communication (email for now) template.',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['subject', 'contentMarkdown', 'name'],
+            properties: {
+              name: {
+                type: 'string',
+                description: 'Name of the template.',
+              },
+              contentMarkdown: {
+                type: 'string',
+                description:
+                  'Content of the template, markdown supported, can contain variable placeholders.',
+              },
+              subject: {
+                type: 'string',
+                description: 'Subject of the message, used in emails.',
+              },
+              createdBy: {
+                type: 'string',
+                format: 'did',
+                description: 'DID of the user who is creating the template.',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'ref',
+            ref: 'lex:com.atproto.admin.defs#communicationTemplateView',
+          },
+        },
+      },
+    },
+  },
   ComAtprotoAdminDefs: {
     lexicon: 1,
     id: 'com.atproto.admin.defs',
@@ -850,6 +895,52 @@ export const schemaDict = {
           },
         },
       },
+      communicationTemplateView: {
+        type: 'object',
+        required: [
+          'id',
+          'name',
+          'contentMarkdown',
+          'disabled',
+          'lastUpdatedBy',
+          'createdAt',
+          'updatedAt',
+        ],
+        properties: {
+          id: {
+            type: 'string',
+          },
+          name: {
+            type: 'string',
+            description: 'Name of the template.',
+          },
+          subject: {
+            type: 'string',
+            description:
+              'Content of the template, can contain markdown and variable placeholders.',
+          },
+          contentMarkdown: {
+            type: 'string',
+            description: 'Subject of the message, used in emails.',
+          },
+          disabled: {
+            type: 'boolean',
+          },
+          lastUpdatedBy: {
+            type: 'string',
+            format: 'did',
+            description: 'DID of the user who last updated the template.',
+          },
+          createdAt: {
+            type: 'string',
+            format: 'datetime',
+          },
+          updatedAt: {
+            type: 'string',
+            format: 'datetime',
+          },
+        },
+      },
     },
   },
   ComAtprotoAdminDeleteAccount: {
@@ -875,6 +966,28 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoAdminDeleteCommunicationTemplate: {
+    lexicon: 1,
+    id: 'com.atproto.admin.deleteCommunicationTemplate',
+    defs: {
+      main: {
+        type: 'procedure',
+        description: 'Delete a communication template.',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['id'],
+            properties: {
+              id: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoAdminDisableAccountInvites: {
     lexicon: 1,
     id: 'com.atproto.admin.disableAccountInvites',
@@ -1282,6 +1395,32 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoAdminListCommunicationTemplates: {
+    lexicon: 1,
+    id: 'com.atproto.admin.listCommunicationTemplates',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Get list of all communication templates.',
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['communicationTemplates'],
+            properties: {
+              communicationTemplates: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:com.atproto.admin.defs#communicationTemplateView',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoAdminQueryModerationEvents: {
     lexicon: 1,
     id: 'com.atproto.admin.queryModerationEvents',
@@ -1619,6 +1758,58 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoAdminUpdateCommunicationTemplate: {
+    lexicon: 1,
+    id: 'com.atproto.admin.updateCommunicationTemplate',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Administrative action to update an existing communication template. Allows passing partial fields to patch specific fields only.',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['id'],
+            properties: {
+              id: {
+                type: 'string',
+                description: 'ID of the template to be updated.',
+              },
+              name: {
+                type: 'string',
+                description: 'Name of the template.',
+              },
+              contentMarkdown: {
+                type: 'string',
+                description:
+                  'Content of the template, markdown supported, can contain variable placeholders.',
+              },
+              subject: {
+                type: 'string',
+                description: 'Subject of the message, used in emails.',
+              },
+              updatedBy: {
+                type: 'string',
+                format: 'did',
+                description: 'DID of the user who is updating the template.',
+              },
+              disabled: {
+                type: 'boolean',
+              },
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'ref',
+            ref: 'lex:com.atproto.admin.defs#communicationTemplateView',
+          },
+        },
+      },
+    },
+  },
   ComAtprotoAdminUpdateSubjectStatus: {
     lexicon: 1,
     id: 'com.atproto.admin.updateSubjectStatus',
@@ -7896,8 +8087,12 @@ export const schemaDict = {
 export const schemas: LexiconDoc[] = Object.values(schemaDict) as LexiconDoc[]
 export const lexicons: Lexicons = new Lexicons(schemas)
 export const ids = {
+  ComAtprotoAdminCreateCommunicationTemplate:
+    'com.atproto.admin.createCommunicationTemplate',
   ComAtprotoAdminDefs: 'com.atproto.admin.defs',
   ComAtprotoAdminDeleteAccount: 'com.atproto.admin.deleteAccount',
+  ComAtprotoAdminDeleteCommunicationTemplate:
+    'com.atproto.admin.deleteCommunicationTemplate',
   ComAtprotoAdminDisableAccountInvites:
     'com.atproto.admin.disableAccountInvites',
   ComAtprotoAdminDisableInviteCodes: 'com.atproto.admin.disableInviteCodes',
@@ -7910,6 +8105,8 @@ export const ids = {
   ComAtprotoAdminGetRecord: 'com.atproto.admin.getRecord',
   ComAtprotoAdminGetRepo: 'com.atproto.admin.getRepo',
   ComAtprotoAdminGetSubjectStatus: 'com.atproto.admin.getSubjectStatus',
+  ComAtprotoAdminListCommunicationTemplates:
+    'com.atproto.admin.listCommunicationTemplates',
   ComAtprotoAdminQueryModerationEvents:
     'com.atproto.admin.queryModerationEvents',
   ComAtprotoAdminQueryModerationStatuses:
@@ -7918,6 +8115,8 @@ export const ids = {
   ComAtprotoAdminSendEmail: 'com.atproto.admin.sendEmail',
   ComAtprotoAdminUpdateAccountEmail: 'com.atproto.admin.updateAccountEmail',
   ComAtprotoAdminUpdateAccountHandle: 'com.atproto.admin.updateAccountHandle',
+  ComAtprotoAdminUpdateCommunicationTemplate:
+    'com.atproto.admin.updateCommunicationTemplate',
   ComAtprotoAdminUpdateSubjectStatus: 'com.atproto.admin.updateSubjectStatus',
   ComAtprotoIdentityResolveHandle: 'com.atproto.identity.resolveHandle',
   ComAtprotoIdentityUpdateHandle: 'com.atproto.identity.updateHandle',

package/src/lexicon/types/com/atproto/admin/createCommunicationTemplate.ts

@@ -0,0 +1,54 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+import { HandlerAuth } from '@atproto/xrpc-server'
+import * as ComAtprotoAdminDefs from './defs'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** Name of the template. */
+  name: string
+  /** Content of the template, markdown supported, can contain variable placeholders. */
+  contentMarkdown: string
+  /** Subject of the message, used in emails. */
+  subject: string
+  /** DID of the user who is creating the template. */
+  createdBy?: string
+  [k: string]: unknown
+}
+
+export type OutputSchema = ComAtprotoAdminDefs.CommunicationTemplateView
+
+export interface HandlerInput {
+  encoding: 'application/json'
+  body: InputSchema
+}
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput

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

@@ -717,3 +717,38 @@ export function isModEventEmail(v: unknown): v is ModEventEmail {
 export function validateModEventEmail(v: unknown): ValidationResult {
   return lexicons.validate('com.atproto.admin.defs#modEventEmail', v)
 }
+
+export interface CommunicationTemplateView {
+  id: string
+  /** Name of the template. */
+  name: string
+  /** Content of the template, can contain markdown and variable placeholders. */
+  subject?: string
+  /** Subject of the message, used in emails. */
+  contentMarkdown: string
+  disabled: boolean
+  /** DID of the user who last updated the template. */
+  lastUpdatedBy: string
+  createdAt: string
+  updatedAt: string
+  [k: string]: unknown
+}
+
+export function isCommunicationTemplateView(
+  v: unknown,
+): v is CommunicationTemplateView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'com.atproto.admin.defs#communicationTemplateView'
+  )
+}
+
+export function validateCommunicationTemplateView(
+  v: unknown,
+): ValidationResult {
+  return lexicons.validate(
+    'com.atproto.admin.defs#communicationTemplateView',
+    v,
+  )
+}