@atproto/api 0.11.0-next.0 → 0.11.1

package/src/client/types/{com/atproto/admin → tools/ozone/moderation}/getRecord.ts

@@ -6,7 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
+import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
   uri: string
@@ -14,7 +14,7 @@ export interface QueryParams {
 }
 
 export type InputSchema = undefined
-export type OutputSchema = ComAtprotoAdminDefs.RecordViewDetail
+export type OutputSchema = ToolsOzoneModerationDefs.RecordViewDetail
 
 export interface CallOptions {
   headers?: Headers

package/src/client/types/{com/atproto/admin → tools/ozone/moderation}/getRepo.ts

@@ -6,14 +6,14 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
+import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
   did: string
 }
 
 export type InputSchema = undefined
-export type OutputSchema = ComAtprotoAdminDefs.RepoViewDetail
+export type OutputSchema = ToolsOzoneModerationDefs.RepoViewDetail
 
 export interface CallOptions {
   headers?: Headers

package/src/client/types/{com/atproto/admin/queryModerationEvents.ts → tools/ozone/moderation/queryEvents.ts}

@@ -6,10 +6,10 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
+import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
-  /** The types of events (fully qualified string in the format of com.atproto.admin#modEvent<name>) to filter by. If not specified, all events are returned. */
+  /** The types of events (fully qualified string in the format of tools.ozone.moderation.defs#modEvent<name>) to filter by. If not specified, all events are returned. */
   types?: string[]
   createdBy?: string
   /** Sort direction for the events. Defaults to descending order of created at timestamp. */
@@ -42,7 +42,7 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   cursor?: string
-  events: ComAtprotoAdminDefs.ModEventView[]
+  events: ToolsOzoneModerationDefs.ModEventView[]
   [k: string]: unknown
 }
 

package/src/client/types/{com/atproto/admin/queryModerationStatuses.ts → tools/ozone/moderation/queryStatuses.ts}

@@ -6,7 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
+import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
   subject?: string
@@ -43,7 +43,7 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   cursor?: string
-  subjectStatuses: ComAtprotoAdminDefs.SubjectStatusView[]
+  subjectStatuses: ToolsOzoneModerationDefs.SubjectStatusView[]
   [k: string]: unknown
 }
 

package/src/client/types/{com/atproto/admin → tools/ozone/moderation}/searchRepos.ts

@@ -6,7 +6,7 @@ import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
 import { CID } from 'multiformats/cid'
-import * as ComAtprotoAdminDefs from './defs'
+import * as ToolsOzoneModerationDefs from './defs'
 
 export interface QueryParams {
   /** DEPRECATED: use 'q' instead */
@@ -20,7 +20,7 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   cursor?: string
-  repos: ComAtprotoAdminDefs.RepoView[]
+  repos: ToolsOzoneModerationDefs.RepoView[]
   [k: string]: unknown
 }
 

package/src/const.ts

@@ -0,0 +1 @@
+export const BSKY_LABELER_DID = 'did:plc:ar7c4by46qjdydhdevvrndac'

package/src/index.ts

@@ -8,14 +8,17 @@ export {
 } from '@atproto/lexicon'
 export { parseLanguage } from '@atproto/common-web'
 export * from './types'
+export * from './const'
+export * from './util'
 export * from './client'
 export * from './agent'
 export * from './rich-text/rich-text'
 export * from './rich-text/sanitization'
 export * from './rich-text/unicode'
+export * from './rich-text/util'
 export * from './moderation'
 export * from './moderation/types'
-export { LABELS } from './moderation/const/labels'
-export { LABEL_GROUPS } from './moderation/const/label-groups'
+export * from './mocker'
+export { LABELS, DEFAULT_LABEL_SETTINGS } from './moderation/const/labels'
 export { BskyAgent } from './bsky-agent'
 export { AtpAgent as default } from './agent'

package/src/mocker.ts

@@ -0,0 +1,218 @@
+import {
+  ComAtprotoLabelDefs,
+  AppBskyFeedDefs,
+  AppBskyActorDefs,
+  AppBskyFeedPost,
+  AppBskyEmbedRecord,
+  AppBskyGraphDefs,
+  AppBskyNotificationListNotifications,
+} from './client'
+
+const FAKE_CID = 'bafyreiclp443lavogvhj3d2ob2cxbfuscni2k5jk7bebjzg7khl3esabwq'
+
+export const mock = {
+  post({
+    text,
+    facets,
+    reply,
+    embed,
+  }: {
+    text: string
+    facets?: AppBskyFeedPost.Record['facets']
+    reply?: AppBskyFeedPost.ReplyRef
+    embed?: AppBskyFeedPost.Record['embed']
+  }): AppBskyFeedPost.Record {
+    return {
+      $type: 'app.bsky.feed.post',
+      text,
+      facets,
+      reply,
+      embed,
+      langs: ['en'],
+      createdAt: new Date().toISOString(),
+    }
+  },
+
+  postView({
+    record,
+    author,
+    embed,
+    replyCount,
+    repostCount,
+    likeCount,
+    viewer,
+    labels,
+  }: {
+    record: AppBskyFeedPost.Record
+    author: AppBskyActorDefs.ProfileViewBasic
+    embed?: AppBskyFeedDefs.PostView['embed']
+    replyCount?: number
+    repostCount?: number
+    likeCount?: number
+    viewer?: AppBskyFeedDefs.ViewerState
+    labels?: ComAtprotoLabelDefs.Label[]
+  }): AppBskyFeedDefs.PostView {
+    return {
+      $type: 'app.bsky.feed.defs#postView',
+      uri: `at://${author.did}/app.bsky.feed.post/fake`,
+      cid: FAKE_CID,
+      author,
+      record,
+      embed,
+      replyCount,
+      repostCount,
+      likeCount,
+      indexedAt: new Date().toISOString(),
+      viewer,
+      labels,
+    }
+  },
+
+  embedRecordView({
+    record,
+    author,
+    labels,
+  }: {
+    record: AppBskyFeedPost.Record
+    author: AppBskyActorDefs.ProfileViewBasic
+    labels?: ComAtprotoLabelDefs.Label[]
+  }): AppBskyEmbedRecord.View {
+    return {
+      $type: 'app.bsky.embed.record#view',
+      record: {
+        $type: 'app.bsky.embed.record#viewRecord',
+        uri: `at://${author.did}/app.bsky.feed.post/fake`,
+        cid: FAKE_CID,
+        author,
+        value: record,
+        labels,
+        indexedAt: new Date().toISOString(),
+      },
+    }
+  },
+
+  profileViewBasic({
+    handle,
+    displayName,
+    description,
+    viewer,
+    labels,
+  }: {
+    handle: string
+    displayName?: string
+    description?: string
+    viewer?: AppBskyActorDefs.ViewerState
+    labels?: ComAtprotoLabelDefs.Label[]
+  }): AppBskyActorDefs.ProfileViewBasic {
+    return {
+      did: `did:web:${handle}`,
+      handle,
+      displayName,
+      description, // technically not in ProfileViewBasic but useful in some cases
+      viewer,
+      labels,
+    }
+  },
+
+  actorViewerState({
+    muted,
+    mutedByList,
+    blockedBy,
+    blocking,
+    blockingByList,
+    following,
+    followedBy,
+  }: {
+    muted?: boolean
+    mutedByList?: AppBskyGraphDefs.ListViewBasic
+    blockedBy?: boolean
+    blocking?: string
+    blockingByList?: AppBskyGraphDefs.ListViewBasic
+    following?: string
+    followedBy?: string
+  }): AppBskyActorDefs.ViewerState {
+    return {
+      muted,
+      mutedByList,
+      blockedBy,
+      blocking,
+      blockingByList,
+      following,
+      followedBy,
+    }
+  },
+
+  listViewBasic({ name }: { name: string }): AppBskyGraphDefs.ListViewBasic {
+    return {
+      uri: 'at://did:plc:fake/app.bsky.graph.list/fake',
+      cid: FAKE_CID,
+      name,
+      purpose: 'app.bsky.graph.defs#modlist',
+      indexedAt: new Date().toISOString(),
+    }
+  },
+
+  replyNotification({
+    author,
+    record,
+    labels,
+  }: {
+    record: AppBskyFeedPost.Record
+    author: AppBskyActorDefs.ProfileViewBasic
+    labels?: ComAtprotoLabelDefs.Label[]
+  }): AppBskyNotificationListNotifications.Notification {
+    return {
+      uri: `at://${author.did}/app.bsky.feed.post/fake`,
+      cid: FAKE_CID,
+      author,
+      reason: 'reply',
+      reasonSubject: `at://${author.did}/app.bsky.feed.post/fake-parent`,
+      record,
+      isRead: false,
+      indexedAt: new Date().toISOString(),
+      labels,
+    }
+  },
+
+  followNotification({
+    author,
+    subjectDid,
+    labels,
+  }: {
+    author: AppBskyActorDefs.ProfileViewBasic
+    subjectDid: string
+    labels?: ComAtprotoLabelDefs.Label[]
+  }): AppBskyNotificationListNotifications.Notification {
+    return {
+      uri: `at://${author.did}/app.bsky.graph.follow/fake`,
+      cid: FAKE_CID,
+      author,
+      reason: 'follow',
+      record: {
+        $type: 'app.bsky.graph.follow',
+        createdAt: new Date().toISOString(),
+        subject: subjectDid,
+      },
+      isRead: false,
+      indexedAt: new Date().toISOString(),
+      labels,
+    }
+  },
+
+  label({
+    val,
+    uri,
+    src,
+  }: {
+    val: string
+    uri: string
+    src?: string
+  }): ComAtprotoLabelDefs.Label {
+    return {
+      src: src || 'did:plc:fake-labeler',
+      uri,
+      val,
+      cts: new Date().toISOString(),
+    }
+  },
+}