@atproto/api 0.10.5-next.0 → 0.11.0-next

package/src/client/types/tools/ozone/moderation/defs.ts

@@ -0,0 +1,641 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+import * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
+import * as ComAtprotoModerationDefs from '../../../com/atproto/moderation/defs'
+import * as ComAtprotoServerDefs from '../../../com/atproto/server/defs'
+import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
+
+export interface ModEventView {
+  id: number
+  event:
+    | ModEventTakedown
+    | ModEventReverseTakedown
+    | ModEventComment
+    | ModEventReport
+    | ModEventLabel
+    | ModEventAcknowledge
+    | ModEventEscalate
+    | ModEventMute
+    | ModEventEmail
+    | ModEventResolveAppeal
+    | ModEventDivert
+    | { $type: string; [k: string]: unknown }
+  subject:
+    | ComAtprotoAdminDefs.RepoRef
+    | ComAtprotoRepoStrongRef.Main
+    | { $type: string; [k: string]: unknown }
+  subjectBlobCids: string[]
+  createdBy: string
+  createdAt: string
+  creatorHandle?: string
+  subjectHandle?: string
+  [k: string]: unknown
+}
+
+export function isModEventView(v: unknown): v is ModEventView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventView'
+  )
+}
+
+export function validateModEventView(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventView', v)
+}
+
+export interface ModEventViewDetail {
+  id: number
+  event:
+    | ModEventTakedown
+    | ModEventReverseTakedown
+    | ModEventComment
+    | ModEventReport
+    | ModEventLabel
+    | ModEventAcknowledge
+    | ModEventEscalate
+    | ModEventMute
+    | ModEventEmail
+    | ModEventResolveAppeal
+    | ModEventDivert
+    | { $type: string; [k: string]: unknown }
+  subject:
+    | RepoView
+    | RepoViewNotFound
+    | RecordView
+    | RecordViewNotFound
+    | { $type: string; [k: string]: unknown }
+  subjectBlobs: BlobView[]
+  createdBy: string
+  createdAt: string
+  [k: string]: unknown
+}
+
+export function isModEventViewDetail(v: unknown): v is ModEventViewDetail {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventViewDetail'
+  )
+}
+
+export function validateModEventViewDetail(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventViewDetail', v)
+}
+
+export interface SubjectStatusView {
+  id: number
+  subject:
+    | ComAtprotoAdminDefs.RepoRef
+    | ComAtprotoRepoStrongRef.Main
+    | { $type: string; [k: string]: unknown }
+  subjectBlobCids?: string[]
+  subjectRepoHandle?: string
+  /** Timestamp referencing when the last update was made to the moderation status of the subject */
+  updatedAt: string
+  /** Timestamp referencing the first moderation status impacting event was emitted on the subject */
+  createdAt: string
+  reviewState: SubjectReviewState
+  /** Sticky comment on the subject. */
+  comment?: string
+  muteUntil?: string
+  lastReviewedBy?: string
+  lastReviewedAt?: string
+  lastReportedAt?: string
+  /** Timestamp referencing when the author of the subject appealed a moderation action */
+  lastAppealedAt?: string
+  takendown?: boolean
+  /** True indicates that the a previously taken moderator action was appealed against, by the author of the content. False indicates last appeal was resolved by moderators. */
+  appealed?: boolean
+  suspendUntil?: string
+  tags?: string[]
+  [k: string]: unknown
+}
+
+export function isSubjectStatusView(v: unknown): v is SubjectStatusView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#subjectStatusView'
+  )
+}
+
+export function validateSubjectStatusView(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#subjectStatusView', v)
+}
+
+export type SubjectReviewState =
+  | 'lex:tools.ozone.moderation.defs#reviewOpen'
+  | 'lex:tools.ozone.moderation.defs#reviewEscalated'
+  | 'lex:tools.ozone.moderation.defs#reviewClosed'
+  | 'lex:tools.ozone.moderation.defs#reviewNone'
+  | (string & {})
+
+/** Moderator review status of a subject: Open. Indicates that the subject needs to be reviewed by a moderator */
+export const REVIEWOPEN = 'tools.ozone.moderation.defs#reviewOpen'
+/** Moderator review status of a subject: Escalated. Indicates that the subject was escalated for review by a moderator */
+export const REVIEWESCALATED = 'tools.ozone.moderation.defs#reviewEscalated'
+/** Moderator review status of a subject: Closed. Indicates that the subject was already reviewed and resolved by a moderator */
+export const REVIEWCLOSED = 'tools.ozone.moderation.defs#reviewClosed'
+/** Moderator review status of a subject: Unnecessary. Indicates that the subject does not need a review at the moment but there is probably some moderation related metadata available for it */
+export const REVIEWNONE = 'tools.ozone.moderation.defs#reviewNone'
+
+/** Take down a subject permanently or temporarily */
+export interface ModEventTakedown {
+  comment?: string
+  /** Indicates how long the takedown should be in effect before automatically expiring. */
+  durationInHours?: number
+  [k: string]: unknown
+}
+
+export function isModEventTakedown(v: unknown): v is ModEventTakedown {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventTakedown'
+  )
+}
+
+export function validateModEventTakedown(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventTakedown', v)
+}
+
+/** Revert take down action on a subject */
+export interface ModEventReverseTakedown {
+  /** Describe reasoning behind the reversal. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventReverseTakedown(
+  v: unknown,
+): v is ModEventReverseTakedown {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventReverseTakedown'
+  )
+}
+
+export function validateModEventReverseTakedown(v: unknown): ValidationResult {
+  return lexicons.validate(
+    'tools.ozone.moderation.defs#modEventReverseTakedown',
+    v,
+  )
+}
+
+/** Resolve appeal on a subject */
+export interface ModEventResolveAppeal {
+  /** Describe resolution. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventResolveAppeal(
+  v: unknown,
+): v is ModEventResolveAppeal {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventResolveAppeal'
+  )
+}
+
+export function validateModEventResolveAppeal(v: unknown): ValidationResult {
+  return lexicons.validate(
+    'tools.ozone.moderation.defs#modEventResolveAppeal',
+    v,
+  )
+}
+
+/** Add a comment to a subject */
+export interface ModEventComment {
+  comment: string
+  /** Make the comment persistent on the subject */
+  sticky?: boolean
+  [k: string]: unknown
+}
+
+export function isModEventComment(v: unknown): v is ModEventComment {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventComment'
+  )
+}
+
+export function validateModEventComment(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventComment', v)
+}
+
+/** Report a subject */
+export interface ModEventReport {
+  comment?: string
+  reportType: ComAtprotoModerationDefs.ReasonType
+  [k: string]: unknown
+}
+
+export function isModEventReport(v: unknown): v is ModEventReport {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventReport'
+  )
+}
+
+export function validateModEventReport(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventReport', v)
+}
+
+/** Apply/Negate labels on a subject */
+export interface ModEventLabel {
+  comment?: string
+  createLabelVals: string[]
+  negateLabelVals: string[]
+  [k: string]: unknown
+}
+
+export function isModEventLabel(v: unknown): v is ModEventLabel {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventLabel'
+  )
+}
+
+export function validateModEventLabel(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventLabel', v)
+}
+
+export interface ModEventAcknowledge {
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventAcknowledge(v: unknown): v is ModEventAcknowledge {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventAcknowledge'
+  )
+}
+
+export function validateModEventAcknowledge(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventAcknowledge', v)
+}
+
+export interface ModEventEscalate {
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventEscalate(v: unknown): v is ModEventEscalate {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventEscalate'
+  )
+}
+
+export function validateModEventEscalate(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventEscalate', v)
+}
+
+/** Mute incoming reports on a subject */
+export interface ModEventMute {
+  comment?: string
+  /** Indicates how long the subject should remain muted. */
+  durationInHours: number
+  [k: string]: unknown
+}
+
+export function isModEventMute(v: unknown): v is ModEventMute {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventMute'
+  )
+}
+
+export function validateModEventMute(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventMute', v)
+}
+
+/** Unmute action on a subject */
+export interface ModEventUnmute {
+  /** Describe reasoning behind the reversal. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventUnmute(v: unknown): v is ModEventUnmute {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventUnmute'
+  )
+}
+
+export function validateModEventUnmute(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventUnmute', v)
+}
+
+/** Keep a log of outgoing email to a user */
+export interface ModEventEmail {
+  /** The subject line of the email sent to the user. */
+  subjectLine: string
+  /** The content of the email sent to the user. */
+  content?: string
+  /** Additional comment about the outgoing comm. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventEmail(v: unknown): v is ModEventEmail {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventEmail'
+  )
+}
+
+export function validateModEventEmail(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventEmail', v)
+}
+
+/** Divert a record's blobs to a 3rd party service for further scanning/tagging */
+export interface ModEventDivert {
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventDivert(v: unknown): v is ModEventDivert {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventDivert'
+  )
+}
+
+export function validateModEventDivert(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventDivert', v)
+}
+
+/** Add/Remove a tag on a subject */
+export interface ModEventTag {
+  /** Tags to be added to the subject. If already exists, won't be duplicated. */
+  add: string[]
+  /** Tags to be removed to the subject. Ignores a tag If it doesn't exist, won't be duplicated. */
+  remove: string[]
+  /** Additional comment about added/removed tags. */
+  comment?: string
+  [k: string]: unknown
+}
+
+export function isModEventTag(v: unknown): v is ModEventTag {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#modEventTag'
+  )
+}
+
+export function validateModEventTag(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#modEventTag', v)
+}
+
+export interface RepoView {
+  did: string
+  handle: string
+  email?: string
+  relatedRecords: {}[]
+  indexedAt: string
+  moderation: Moderation
+  invitedBy?: ComAtprotoServerDefs.InviteCode
+  invitesDisabled?: boolean
+  inviteNote?: string
+  [k: string]: unknown
+}
+
+export function isRepoView(v: unknown): v is RepoView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#repoView'
+  )
+}
+
+export function validateRepoView(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#repoView', v)
+}
+
+export interface RepoViewDetail {
+  did: string
+  handle: string
+  email?: string
+  relatedRecords: {}[]
+  indexedAt: string
+  moderation: ModerationDetail
+  labels?: ComAtprotoLabelDefs.Label[]
+  invitedBy?: ComAtprotoServerDefs.InviteCode
+  invites?: ComAtprotoServerDefs.InviteCode[]
+  invitesDisabled?: boolean
+  inviteNote?: string
+  emailConfirmedAt?: string
+  [k: string]: unknown
+}
+
+export function isRepoViewDetail(v: unknown): v is RepoViewDetail {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#repoViewDetail'
+  )
+}
+
+export function validateRepoViewDetail(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#repoViewDetail', v)
+}
+
+export interface RepoViewNotFound {
+  did: string
+  [k: string]: unknown
+}
+
+export function isRepoViewNotFound(v: unknown): v is RepoViewNotFound {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#repoViewNotFound'
+  )
+}
+
+export function validateRepoViewNotFound(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#repoViewNotFound', v)
+}
+
+export interface RecordView {
+  uri: string
+  cid: string
+  value: {}
+  blobCids: string[]
+  indexedAt: string
+  moderation: Moderation
+  repo: RepoView
+  [k: string]: unknown
+}
+
+export function isRecordView(v: unknown): v is RecordView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#recordView'
+  )
+}
+
+export function validateRecordView(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#recordView', v)
+}
+
+export interface RecordViewDetail {
+  uri: string
+  cid: string
+  value: {}
+  blobs: BlobView[]
+  labels?: ComAtprotoLabelDefs.Label[]
+  indexedAt: string
+  moderation: ModerationDetail
+  repo: RepoView
+  [k: string]: unknown
+}
+
+export function isRecordViewDetail(v: unknown): v is RecordViewDetail {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#recordViewDetail'
+  )
+}
+
+export function validateRecordViewDetail(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#recordViewDetail', v)
+}
+
+export interface RecordViewNotFound {
+  uri: string
+  [k: string]: unknown
+}
+
+export function isRecordViewNotFound(v: unknown): v is RecordViewNotFound {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#recordViewNotFound'
+  )
+}
+
+export function validateRecordViewNotFound(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#recordViewNotFound', v)
+}
+
+export interface Moderation {
+  subjectStatus?: SubjectStatusView
+  [k: string]: unknown
+}
+
+export function isModeration(v: unknown): v is Moderation {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#moderation'
+  )
+}
+
+export function validateModeration(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#moderation', v)
+}
+
+export interface ModerationDetail {
+  subjectStatus?: SubjectStatusView
+  [k: string]: unknown
+}
+
+export function isModerationDetail(v: unknown): v is ModerationDetail {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#moderationDetail'
+  )
+}
+
+export function validateModerationDetail(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#moderationDetail', v)
+}
+
+export interface BlobView {
+  cid: string
+  mimeType: string
+  size: number
+  createdAt: string
+  details?:
+    | ImageDetails
+    | VideoDetails
+    | { $type: string; [k: string]: unknown }
+  moderation?: Moderation
+  [k: string]: unknown
+}
+
+export function isBlobView(v: unknown): v is BlobView {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#blobView'
+  )
+}
+
+export function validateBlobView(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#blobView', v)
+}
+
+export interface ImageDetails {
+  width: number
+  height: number
+  [k: string]: unknown
+}
+
+export function isImageDetails(v: unknown): v is ImageDetails {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#imageDetails'
+  )
+}
+
+export function validateImageDetails(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#imageDetails', v)
+}
+
+export interface VideoDetails {
+  width: number
+  height: number
+  length: number
+  [k: string]: unknown
+}
+
+export function isVideoDetails(v: unknown): v is VideoDetails {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'tools.ozone.moderation.defs#videoDetails'
+  )
+}
+
+export function validateVideoDetails(v: unknown): ValidationResult {
+  return lexicons.validate('tools.ozone.moderation.defs#videoDetails', v)
+}

package/src/client/types/tools/ozone/moderation/emitEvent.ts

@@ -0,0 +1,63 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+import * as ToolsOzoneModerationDefs from './defs'
+import * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  event:
+    | ToolsOzoneModerationDefs.ModEventTakedown
+    | ToolsOzoneModerationDefs.ModEventAcknowledge
+    | ToolsOzoneModerationDefs.ModEventEscalate
+    | ToolsOzoneModerationDefs.ModEventComment
+    | ToolsOzoneModerationDefs.ModEventLabel
+    | ToolsOzoneModerationDefs.ModEventReport
+    | ToolsOzoneModerationDefs.ModEventMute
+    | ToolsOzoneModerationDefs.ModEventReverseTakedown
+    | ToolsOzoneModerationDefs.ModEventUnmute
+    | ToolsOzoneModerationDefs.ModEventEmail
+    | ToolsOzoneModerationDefs.ModEventTag
+    | { $type: string; [k: string]: unknown }
+  subject:
+    | ComAtprotoAdminDefs.RepoRef
+    | ComAtprotoRepoStrongRef.Main
+    | { $type: string; [k: string]: unknown }
+  subjectBlobCids?: string[]
+  createdBy: string
+  [k: string]: unknown
+}
+
+export type OutputSchema = ToolsOzoneModerationDefs.ModEventView
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+  encoding: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export class SubjectHasActionError extends XRPCError {
+  constructor(src: XRPCError) {
+    super(src.status, src.error, src.message, src.headers)
+  }
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+    if (e.error === 'SubjectHasAction') return new SubjectHasActionError(e)
+  }
+  return e
+}