@atproto/ozone 0.1.126 → 0.1.128

package/src/lexicon/types/tools/ozone/safelink/addRule.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 ToolsOzoneSafelinkDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'tools.ozone.safelink.addRule'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** The URL or domain to apply the rule to */
+  url: string
+  pattern: ToolsOzoneSafelinkDefs.PatternType
+  action: ToolsOzoneSafelinkDefs.ActionType
+  reason: ToolsOzoneSafelinkDefs.ReasonType
+  /** Optional comment about the decision */
+  comment?: string
+  /** Author DID. Only respected when using admin auth */
+  createdBy?: string
+}
+
+export type OutputSchema = ToolsOzoneSafelinkDefs.Event
+
+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
+  error?: 'InvalidUrl' | 'RuleAlreadyExists'
+}
+
+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/tools/ozone/safelink/defs.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 = 'tools.ozone.safelink.defs'
+
+/** An event for URL safety decisions */
+export interface Event {
+  $type?: 'tools.ozone.safelink.defs#event'
+  /** Auto-incrementing row ID */
+  id: number
+  eventType: EventType
+  /** The URL that this rule applies to */
+  url: string
+  pattern: PatternType
+  action: ActionType
+  reason: ReasonType
+  /** DID of the user who created this rule */
+  createdBy: string
+  createdAt: string
+  /** Optional comment about the decision */
+  comment?: string
+}
+
+const hashEvent = 'event'
+
+export function isEvent<V>(v: V) {
+  return is$typed(v, id, hashEvent)
+}
+
+export function validateEvent<V>(v: V) {
+  return validate<Event & V>(v, id, hashEvent)
+}
+
+export type EventType = 'addRule' | 'updateRule' | 'removeRule' | (string & {})
+export type PatternType = 'domain' | 'url' | (string & {})
+export type ActionType = 'block' | 'warn' | 'whitelist' | (string & {})
+export type ReasonType = 'csam' | 'spam' | 'phishing' | 'none' | (string & {})
+
+/** Input for creating a URL safety rule */
+export interface UrlRule {
+  $type?: 'tools.ozone.safelink.defs#urlRule'
+  /** The URL or domain to apply the rule to */
+  url: string
+  pattern: PatternType
+  action: ActionType
+  reason: ReasonType
+  /** Optional comment about the decision */
+  comment?: string
+  /** DID of the user added the rule. */
+  createdBy: string
+  /** Timestamp when the rule was created */
+  createdAt: string
+  /** Timestamp when the rule was last updated */
+  updatedAt: string
+}
+
+const hashUrlRule = 'urlRule'
+
+export function isUrlRule<V>(v: V) {
+  return is$typed(v, id, hashUrlRule)
+}
+
+export function validateUrlRule<V>(v: V) {
+  return validate<UrlRule & V>(v, id, hashUrlRule)
+}

package/src/lexicon/types/tools/ozone/safelink/queryEvents.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 ToolsOzoneSafelinkDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'tools.ozone.safelink.queryEvents'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** Cursor for pagination */
+  cursor?: string
+  /** Maximum number of results to return */
+  limit: number
+  /** Filter by specific URLs or domains */
+  urls?: string[]
+  /** Filter by pattern type */
+  patternType?: string
+  /** Sort direction */
+  sortDirection: 'asc' | 'desc' | (string & {})
+}
+
+export interface OutputSchema {
+  /** Next cursor for pagination. Only present if there are more results. */
+  cursor?: string
+  events: ToolsOzoneSafelinkDefs.Event[]
+}
+
+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 | 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/tools/ozone/safelink/queryRules.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 ToolsOzoneSafelinkDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'tools.ozone.safelink.queryRules'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** Cursor for pagination */
+  cursor?: string
+  /** Maximum number of results to return */
+  limit: number
+  /** Filter by specific URLs or domains */
+  urls?: string[]
+  /** Filter by pattern type */
+  patternType?: string
+  /** Filter by action types */
+  actions?: string[]
+  /** Filter by reason type */
+  reason?: string
+  /** Filter by rule creator */
+  createdBy?: string
+  /** Sort direction */
+  sortDirection: 'asc' | 'desc' | (string & {})
+}
+
+export interface OutputSchema {
+  /** Next cursor for pagination. Only present if there are more results. */
+  cursor?: string
+  rules: ToolsOzoneSafelinkDefs.UrlRule[]
+}
+
+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 | 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/tools/ozone/safelink/removeRule.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 ToolsOzoneSafelinkDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'tools.ozone.safelink.removeRule'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** The URL or domain to remove the rule for */
+  url: string
+  pattern: ToolsOzoneSafelinkDefs.PatternType
+  /** Optional comment about why the rule is being removed */
+  comment?: string
+  /** Optional DID of the user. Only respected when using admin auth. */
+  createdBy?: string
+}
+
+export type OutputSchema = ToolsOzoneSafelinkDefs.Event
+
+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
+  error?: 'RuleNotFound'
+}
+
+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/tools/ozone/safelink/updateRule.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 ToolsOzoneSafelinkDefs from './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'tools.ozone.safelink.updateRule'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  /** The URL or domain to update the rule for */
+  url: string
+  pattern: ToolsOzoneSafelinkDefs.PatternType
+  action: ToolsOzoneSafelinkDefs.ActionType
+  reason: ToolsOzoneSafelinkDefs.ReasonType
+  /** Optional comment about the update */
+  comment?: string
+  /** Optional DID to credit as the creator. Only respected for admin_token authentication. */
+  createdBy?: string
+}
+
+export type OutputSchema = ToolsOzoneSafelinkDefs.Event
+
+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
+  error?: 'RuleNotFound'
+}
+
+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/mod-service/index.ts

@@ -1,6 +1,6 @@
 import { Insertable, RawBuilder, sql } from 'kysely'
 import { CID } from 'multiformats/cid'
-import { AtpAgent } from '@atproto/api'
+import { AtpAgent, ToolsOzoneModerationDefs } from '@atproto/api'
 import { addHoursToDate, chunkArray } from '@atproto/common'
 import { Keypair } from '@atproto/crypto'
 import { IdResolver } from '@atproto/identity'
@@ -167,6 +167,7 @@ export class ModerationService {
     collections: string[]
     subjectType?: string
     policies?: string[]
+    modTool?: string[]
   }): Promise<{ cursor?: string; events: ModerationEventRow[] }> {
     const {
       subject,
@@ -188,6 +189,7 @@ export class ModerationService {
       collections,
       subjectType,
       policies,
+      modTool,
     } = opts
     const { ref } = this.db.db.dynamic
     let builder = this.db.db.selectFrom('moderation_event').selectAll()
@@ -288,6 +290,11 @@ export class ModerationService {
         return qb
       })
     }
+    if (modTool?.length) {
+      builder = builder
+        .where('modTool', 'is not', null)
+        .where(sql`("modTool" ->> 'name')`, 'in', modTool)
+    }
 
     const keyset = new TimeIdKeyset(
       ref(`moderation_event.createdAt`),
@@ -397,12 +404,13 @@ export class ModerationService {
     subject: ModSubject
     createdBy: string
     createdAt?: Date
+    modTool?: ToolsOzoneModerationDefs.ModTool
   }): Promise<{
     event: ModerationEventRow
     subjectStatus: ModerationSubjectStatusRow | null
   }> {
     this.db.assertTransaction()
-    const { event, subject, createdBy, createdAt = new Date() } = info
+    const { event, subject, createdBy, createdAt = new Date(), modTool } = info
 
     const createLabelVals =
       isModEventLabel(event) && event.createLabelVals.length > 0
@@ -508,6 +516,7 @@ export class ModerationService {
         subjectCid: subjectInfo.subjectCid,
         subjectBlobCids: jsonb(subjectInfo.subjectBlobCids),
         subjectMessageId: subjectInfo.subjectMessageId,
+        modTool: modTool ? jsonb(modTool) : null,
       })
       .returningAll()
       .executeTakeFirstOrThrow()
@@ -802,6 +811,10 @@ export class ModerationService {
     subject: ModSubject
     reportedBy: string
     createdAt?: Date
+    modTool?: {
+      name: string
+      meta?: { [_ in string]: unknown }
+    }
   }): Promise<{
     event: ModerationEventRow
     subjectStatus: ModerationSubjectStatusRow | null
@@ -812,6 +825,7 @@ export class ModerationService {
       reportedBy,
       createdAt = new Date(),
       subject,
+      modTool,
     } = info
 
     const result = await this.logEvent({
@@ -823,6 +837,7 @@ export class ModerationService {
       createdBy: reportedBy,
       subject,
       createdAt,
+      modTool,
     })
 
     return result

package/src/mod-service/views.ts

@@ -141,6 +141,12 @@ export class ModerationViews {
       createdAt: row.createdAt,
       subjectHandle: row.subjectHandle ?? undefined,
       creatorHandle: row.creatorHandle ?? undefined,
+      modTool: row.modTool
+        ? {
+            name: row.modTool.name,
+            meta: row.modTool.meta,
+          }
+        : undefined,
     }
 
     const { event } = eventView