@atproto/api 0.13.19 → 0.14.0-next.0

package/src/client/types/tools/ozone/setting/upsertOption.ts

@@ -3,29 +3,29 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ToolsOzoneSettingDefs from './defs'
 
+const id = 'tools.ozone.setting.upsertOption'
+
 export interface QueryParams {}
 
 export interface InputSchema {
   key: string
   scope: 'instance' | 'personal' | (string & {})
-  value: {}
+  value: { [_ in string]: unknown }
   description?: string
   managerRole?:
     | 'tools.ozone.team.defs#roleModerator'
     | 'tools.ozone.team.defs#roleTriage'
     | 'tools.ozone.team.defs#roleAdmin'
     | (string & {})
-  [k: string]: unknown
 }
 
 export interface OutputSchema {
   option: ToolsOzoneSettingDefs.Option
-  [k: string]: unknown
 }
 
 export interface CallOptions {

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

@@ -2,24 +2,26 @@
  * 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+
+const id = 'tools.ozone.signature.defs'
 
 export interface SigDetail {
+  $type?: $Type<'tools.ozone.signature.defs', 'sigDetail'>
   property: string
   value: string
-  [k: string]: unknown
 }
 
-export function isSigDetail(v: unknown): v is SigDetail {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'tools.ozone.signature.defs#sigDetail'
-  )
+export function isSigDetail<V>(v: V) {
+  return is$typed(v, id, 'sigDetail')
+}
+
+export function validateSigDetail(v: unknown) {
+  return lexicons.validate(`${id}#sigDetail`, v) as ValidationResult<SigDetail>
 }
 
-export function validateSigDetail(v: unknown): ValidationResult {
-  return lexicons.validate('tools.ozone.signature.defs#sigDetail', v)
+export function isValidSigDetail<V>(v: V): v is V & $Typed<SigDetail> {
+  return isSigDetail(v) && validateSigDetail(v).success
 }

package/src/client/types/tools/ozone/signature/findCorrelation.ts

@@ -3,11 +3,13 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ToolsOzoneSignatureDefs from './defs'
 
+const id = 'tools.ozone.signature.findCorrelation'
+
 export interface QueryParams {
   dids: string[]
 }
@@ -16,7 +18,6 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   details: ToolsOzoneSignatureDefs.SigDetail[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/tools/ozone/signature/findRelatedAccounts.ts

@@ -3,12 +3,14 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
 import * as ToolsOzoneSignatureDefs from './defs'
 
+const id = 'tools.ozone.signature.findRelatedAccounts'
+
 export interface QueryParams {
   did: string
   cursor?: string
@@ -20,7 +22,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   accounts: RelatedAccount[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {
@@ -39,22 +40,24 @@ export function toKnownErr(e: any) {
 }
 
 export interface RelatedAccount {
+  $type?: $Type<'tools.ozone.signature.findRelatedAccounts', 'relatedAccount'>
   account: ComAtprotoAdminDefs.AccountView
   similarities?: ToolsOzoneSignatureDefs.SigDetail[]
-  [k: string]: unknown
 }
 
-export function isRelatedAccount(v: unknown): v is RelatedAccount {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'tools.ozone.signature.findRelatedAccounts#relatedAccount'
-  )
+export function isRelatedAccount<V>(v: V) {
+  return is$typed(v, id, 'relatedAccount')
 }
 
-export function validateRelatedAccount(v: unknown): ValidationResult {
+export function validateRelatedAccount(v: unknown) {
   return lexicons.validate(
-    'tools.ozone.signature.findRelatedAccounts#relatedAccount',
+    `${id}#relatedAccount`,
     v,
-  )
+  ) as ValidationResult<RelatedAccount>
+}
+
+export function isValidRelatedAccount<V>(
+  v: V,
+): v is V & $Typed<RelatedAccount> {
+  return isRelatedAccount(v) && validateRelatedAccount(v).success
 }

package/src/client/types/tools/ozone/signature/searchAccounts.ts

@@ -3,11 +3,13 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
 
+const id = 'tools.ozone.signature.searchAccounts'
+
 export interface QueryParams {
   values: string[]
   cursor?: string
@@ -19,7 +21,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   accounts: ComAtprotoAdminDefs.AccountView[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/tools/ozone/team/addMember.ts

@@ -3,11 +3,13 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ToolsOzoneTeamDefs from './defs'
 
+const id = 'tools.ozone.team.addMember'
+
 export interface QueryParams {}
 
 export interface InputSchema {
@@ -17,7 +19,6 @@ export interface InputSchema {
     | 'tools.ozone.team.defs#roleModerator'
     | 'tools.ozone.team.defs#roleTriage'
     | (string & {})
-  [k: string]: unknown
 }
 
 export type OutputSchema = ToolsOzoneTeamDefs.Member

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

@@ -2,12 +2,15 @@
  * 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as AppBskyActorDefs from '../../../app/bsky/actor/defs'
 
+const id = 'tools.ozone.team.defs'
+
 export interface Member {
+  $type?: $Type<'tools.ozone.team.defs', 'member'>
   did: string
   disabled?: boolean
   profile?: AppBskyActorDefs.ProfileViewDetailed
@@ -19,24 +22,23 @@ export interface Member {
     | 'lex:tools.ozone.team.defs#roleModerator'
     | 'lex:tools.ozone.team.defs#roleTriage'
     | (string & {})
-  [k: string]: unknown
 }
 
-export function isMember(v: unknown): v is Member {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'tools.ozone.team.defs#member'
-  )
+export function isMember<V>(v: V) {
+  return is$typed(v, id, 'member')
+}
+
+export function validateMember(v: unknown) {
+  return lexicons.validate(`${id}#member`, v) as ValidationResult<Member>
 }
 
-export function validateMember(v: unknown): ValidationResult {
-  return lexicons.validate('tools.ozone.team.defs#member', v)
+export function isValidMember<V>(v: V): v is V & $Typed<Member> {
+  return isMember(v) && validateMember(v).success
 }
 
 /** Admin role. Highest level of access, can perform all actions. */
-export const ROLEADMIN = 'tools.ozone.team.defs#roleAdmin'
+export const ROLEADMIN = `${id}#roleAdmin`
 /** Moderator role. Can perform most actions. */
-export const ROLEMODERATOR = 'tools.ozone.team.defs#roleModerator'
+export const ROLEMODERATOR = `${id}#roleModerator`
 /** Triage role. Mostly intended for monitoring and escalating issues. */
-export const ROLETRIAGE = 'tools.ozone.team.defs#roleTriage'
+export const ROLETRIAGE = `${id}#roleTriage`

package/src/client/types/tools/ozone/team/deleteMember.ts

@@ -3,15 +3,16 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+
+const id = 'tools.ozone.team.deleteMember'
 
 export interface QueryParams {}
 
 export interface InputSchema {
   did: string
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/tools/ozone/team/listMembers.ts

@@ -3,11 +3,13 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ToolsOzoneTeamDefs from './defs'
 
+const id = 'tools.ozone.team.listMembers'
+
 export interface QueryParams {
   limit?: number
   cursor?: string
@@ -18,7 +20,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   members: ToolsOzoneTeamDefs.Member[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/tools/ozone/team/updateMember.ts

@@ -3,11 +3,13 @@
  */
 import { HeadersMap, 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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as ToolsOzoneTeamDefs from './defs'
 
+const id = 'tools.ozone.team.updateMember'
+
 export interface QueryParams {}
 
 export interface InputSchema {
@@ -18,7 +20,6 @@ export interface InputSchema {
     | 'tools.ozone.team.defs#roleModerator'
     | 'tools.ozone.team.defs#roleTriage'
     | (string & {})
-  [k: string]: unknown
 }
 
 export type OutputSchema = ToolsOzoneTeamDefs.Member

package/src/client/util.ts

@@ -1,13 +1,49 @@
 /**
  * GENERATED CODE - DO NOT MODIFY
  */
-export function isObj(v: unknown): v is Record<string, unknown> {
-  return typeof v === 'object' && v !== null
+export type OmitKey<T, K extends keyof T> = {
+  [K2 in keyof T as K2 extends K ? never : K2]: T[K2]
 }
 
-export function hasProp<K extends PropertyKey>(
-  data: object,
-  prop: K,
-): data is Record<K, unknown> {
-  return prop in data
+export type $Typed<V> = V & { $type: string }
+
+export type $Type<Id extends string, Hash extends string> = Hash extends 'main'
+  ? Id | `${Id}#${Hash}`
+  : `${Id}#${Hash}`
+
+function has$type<V>(v: V): v is $Typed<V & object> {
+  return (
+    v != null &&
+    typeof v === 'object' &&
+    '$type' in v &&
+    typeof v.$type === 'string'
+  )
+}
+
+function check$type<Id extends string, Hash extends string>(
+  $type: string,
+  id: Id,
+  hash: Hash,
+): $type is $Type<Id, Hash> {
+  return $type === id
+    ? hash === 'main'
+    : // $type === `${id}#${hash}`
+      $type.length === id.length + 1 + hash.length &&
+        $type.charCodeAt(id.length) === 35 /* '#' */ &&
+        $type.startsWith(id) &&
+        $type.endsWith(hash)
+}
+
+export type Is$Typed<V, Id extends string, Hash extends string> = V extends {
+  $type?: string
+}
+  ? Extract<V, { $type: $Type<Id, Hash> }>
+  : V & { $type: $Type<Id, Hash> }
+
+export function is$typed<V, Id extends string, Hash extends string>(
+  v: V,
+  id: Id,
+  hash: Hash,
+): v is Is$Typed<V, Id, Hash> {
+  return has$type(v) && check$type(v.$type, id, hash)
 }

package/src/mocker.ts

@@ -7,6 +7,7 @@ import {
   AppBskyGraphDefs,
   AppBskyNotificationListNotifications,
 } from './client'
+import { $Typed } from './client/util'
 
 const FAKE_CID = 'bafyreiclp443lavogvhj3d2ob2cxbfuscni2k5jk7bebjzg7khl3esabwq'
 
@@ -21,7 +22,7 @@ export const mock = {
     facets?: AppBskyFeedPost.Record['facets']
     reply?: AppBskyFeedPost.ReplyRef
     embed?: AppBskyFeedPost.Record['embed']
-  }): AppBskyFeedPost.Record {
+  }): $Typed<AppBskyFeedPost.Record> {
     return {
       $type: 'app.bsky.feed.post',
       text,
@@ -51,7 +52,7 @@ export const mock = {
     likeCount?: number
     viewer?: AppBskyFeedDefs.ViewerState
     labels?: ComAtprotoLabelDefs.Label[]
-  }): AppBskyFeedDefs.PostView {
+  }): $Typed<AppBskyFeedDefs.PostView> {
     return {
       $type: 'app.bsky.feed.defs#postView',
       uri: `at://${author.did}/app.bsky.feed.post/fake`,
@@ -76,7 +77,7 @@ export const mock = {
     record: AppBskyFeedPost.Record
     author: AppBskyActorDefs.ProfileViewBasic
     labels?: ComAtprotoLabelDefs.Label[]
-  }): AppBskyEmbedRecord.View {
+  }): $Typed<AppBskyEmbedRecord.View> {
     return {
       $type: 'app.bsky.embed.record#view',
       record: {
@@ -108,7 +109,8 @@ export const mock = {
       did: `did:web:${handle}`,
       handle,
       displayName,
-      description, // technically not in ProfileViewBasic but useful in some cases
+      // @ts-expect-error technically not in ProfileViewBasic but useful in some cases
+      description,
       viewer,
       labels,
     }
@@ -158,7 +160,7 @@ export const mock = {
     labels,
   }: {
     record: AppBskyFeedPost.Record
-    author: AppBskyActorDefs.ProfileViewBasic
+    author: Omit<AppBskyActorDefs.ProfileViewBasic, '$type'>
     labels?: ComAtprotoLabelDefs.Label[]
   }): AppBskyNotificationListNotifications.Notification {
     return {
@@ -179,7 +181,7 @@ export const mock = {
     subjectDid,
     labels,
   }: {
-    author: AppBskyActorDefs.ProfileViewBasic
+    author: Omit<AppBskyActorDefs.ProfileViewBasic, '$type'>
     subjectDid: string
     labels?: ComAtprotoLabelDefs.Label[]
   }): AppBskyNotificationListNotifications.Notification {

package/src/moderation/mutewords.ts

@@ -34,7 +34,7 @@ export function hasMutedWord({
   facets?: AppBskyRichtextFacet.Main[]
   outlineTags?: string[]
   languages?: string[]
-  actor?: AppBskyActorDefs.ProfileView
+  actor?: AppBskyActorDefs.ProfileView | AppBskyActorDefs.ProfileViewBasic
 }) {
   const exception = LANGUAGE_EXCEPTIONS.includes(languages?.[0] || '')
   const tags = ([] as string[])

package/src/moderation/subjects/post.ts

@@ -32,7 +32,11 @@ export function decidePost(
 
   let embedAcc
   if (subject.embed) {
-    if (AppBskyEmbedRecord.isViewRecord(subject.embed.record)) {
+    if (
+      (AppBskyEmbedRecord.isView(subject.embed) ||
+        AppBskyEmbedRecordWithMedia.isView(subject.embed)) &&
+      AppBskyEmbedRecord.isViewRecord(subject.embed.record)
+    ) {
       // quote post
       embedAcc = decideQuotedPost(subject.embed.record, opts)
     } else if (
@@ -41,7 +45,11 @@ export function decidePost(
     ) {
       // quoted post with media
       embedAcc = decideQuotedPost(subject.embed.record.record, opts)
-    } else if (AppBskyEmbedRecord.isViewBlocked(subject.embed.record)) {
+    } else if (
+      (AppBskyEmbedRecord.isView(subject.embed) ||
+        AppBskyEmbedRecordWithMedia.isView(subject.embed)) &&
+      AppBskyEmbedRecord.isViewBlocked(subject.embed.record)
+    ) {
       // blocked quote post
       embedAcc = decideBlockedQuotedPost(subject.embed.record, opts)
     } else if (
@@ -115,7 +123,10 @@ function checkHiddenPost(
   if (hiddenPosts.includes(subject.uri)) {
     return true
   }
-  if (subject.embed) {
+  if (
+    AppBskyEmbedRecord.isView(subject.embed) ||
+    AppBskyEmbedRecordWithMedia.isView(subject.embed)
+  ) {
     if (
       AppBskyEmbedRecord.isViewRecord(subject.embed.record) &&
       hiddenPosts.includes(subject.embed.record.uri)
@@ -143,7 +154,7 @@ function checkMutedWords(
 
   const postAuthor = subject.author
 
-  if (AppBskyFeedPost.isRecord(subject.record)) {
+  if (AppBskyFeedPost.isValidRecord(subject.record)) {
     // post text
     if (
       hasMutedWord({
@@ -178,12 +189,17 @@ function checkMutedWords(
     }
   }
 
-  if (subject.embed) {
+  const { embed } = subject
+  if (embed) {
     // quote post
-    if (AppBskyEmbedRecord.isViewRecord(subject.embed.record)) {
-      if (AppBskyFeedPost.isRecord(subject.embed.record.value)) {
-        const embeddedPost = subject.embed.record.value
-        const embedAuthor = subject.embed.record.author
+    if (
+      (AppBskyEmbedRecord.isView(embed) ||
+        AppBskyEmbedRecordWithMedia.isView(embed)) &&
+      AppBskyEmbedRecord.isViewRecord(embed.record)
+    ) {
+      if (AppBskyFeedPost.isValidRecord(embed.record.value)) {
+        const embeddedPost = embed.record.value
+        const embedAuthor = embed.record.author
 
         // quoted post text
         if (
@@ -267,8 +283,8 @@ function checkMutedWords(
       }
     }
     // link card
-    else if (AppBskyEmbedExternal.isView(subject.embed)) {
-      const { external } = subject.embed
+    else if (AppBskyEmbedExternal.isView(embed)) {
+      const { external } = embed
       if (
         hasMutedWord({
           mutedWords,
@@ -282,14 +298,14 @@ function checkMutedWords(
     }
     // quote post with media
     else if (
-      AppBskyEmbedRecordWithMedia.isView(subject.embed) &&
-      AppBskyEmbedRecord.isViewRecord(subject.embed.record.record)
+      AppBskyEmbedRecordWithMedia.isView(embed) &&
+      AppBskyEmbedRecord.isViewRecord(embed.record.record)
     ) {
-      const embedAuthor = subject.embed.record.record.author
+      const embedAuthor = embed.record.record.author
 
       // quoted post text
-      if (AppBskyFeedPost.isRecord(subject.embed.record.record.value)) {
-        const post = subject.embed.record.record.value
+      if (AppBskyFeedPost.isValidRecord(embed.record.record.value)) {
+        const post = embed.record.record.value
         if (
           hasMutedWord({
             mutedWords,
@@ -305,13 +321,13 @@ function checkMutedWords(
       }
 
       // quoted post images
-      if (AppBskyEmbedImages.isView(subject.embed.media)) {
-        for (const image of subject.embed.media.images) {
+      if (AppBskyEmbedImages.isView(embed.media)) {
+        for (const image of embed.media.images) {
           if (
             hasMutedWord({
               mutedWords,
               text: image.alt,
-              languages: AppBskyFeedPost.isRecord(subject.record)
+              languages: AppBskyFeedPost.isValidRecord(subject.record)
                 ? subject.record.langs
                 : [],
               actor: embedAuthor,
@@ -322,8 +338,8 @@ function checkMutedWords(
         }
       }
 
-      if (AppBskyEmbedExternal.isView(subject.embed.media)) {
-        const { external } = subject.embed.media
+      if (AppBskyEmbedExternal.isView(embed.media)) {
+        const { external } = embed.media
         if (
           hasMutedWord({
             mutedWords,

package/src/moderation/subjects/user-list.ts

@@ -11,7 +11,10 @@ export function decideUserList(
 ): ModerationDecision {
   const acc = new ModerationDecision()
 
-  const creator = isProfile(subject.creator) ? subject.creator : undefined
+  const creator =
+    'creator' in subject && isProfile(subject.creator)
+      ? subject.creator
+      : undefined
 
   if (creator) {
     acc.setDid(creator.did)

package/src/rich-text/rich-text.ts

@@ -122,11 +122,7 @@ export class RichTextSegment {
   ) {}
 
   get link(): FacetLink | undefined {
-    const link = this.facet?.features.find(AppBskyRichtextFacet.isLink)
-    if (AppBskyRichtextFacet.isLink(link)) {
-      return link
-    }
-    return undefined
+    return this.facet?.features.find(AppBskyRichtextFacet.isLink)
   }
 
   isLink() {
@@ -134,11 +130,7 @@ export class RichTextSegment {
   }
 
   get mention(): FacetMention | undefined {
-    const mention = this.facet?.features.find(AppBskyRichtextFacet.isMention)
-    if (AppBskyRichtextFacet.isMention(mention)) {
-      return mention
-    }
-    return undefined
+    return this.facet?.features.find(AppBskyRichtextFacet.isMention)
   }
 
   isMention() {
@@ -146,11 +138,7 @@ export class RichTextSegment {
   }
 
   get tag(): FacetTag | undefined {
-    const tag = this.facet?.features.find(AppBskyRichtextFacet.isTag)
-    if (AppBskyRichtextFacet.isTag(tag)) {
-      return tag
-    }
-    return undefined
+    return this.facet?.features.find(AppBskyRichtextFacet.isTag)
   }
 
   isTag() {