@atproto/api 0.13.21 → 0.14.0-next.1

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

@@ -2,14 +2,23 @@
  * 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 {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.setting.defs'
 
 export interface Option {
+  $type?: $Type<'tools.ozone.setting.defs', 'option'>
   key: string
   did: string
-  value: {}
+  value: { [_ in string]: unknown }
   description?: string
   createdAt?: string
   updatedAt?: string
@@ -21,17 +30,18 @@ export interface Option {
   scope: 'instance' | 'personal' | (string & {})
   createdBy: string
   lastUpdatedBy: string
-  [k: string]: unknown
 }
 
-export function isOption(v: unknown): v is Option {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'tools.ozone.setting.defs#option'
-  )
+const hashOption = 'option'
+
+export function isOption<V>(v: V) {
+  return is$typed(v, id, hashOption)
+}
+
+export function validateOption<V>(v: V) {
+  return validate<Option & V>(v, id, hashOption)
 }
 
-export function validateOption(v: unknown): ValidationResult {
-  return lexicons.validate('tools.ozone.setting.defs#option', v)
+export function isValidOption<V>(v: V) {
+  return isValid<Option>(v, id, hashOption)
 }

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

@@ -3,10 +3,18 @@
  */
 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 * as ToolsOzoneSettingDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneSettingDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.setting.listOptions'
 
 export interface QueryParams {
   limit?: number
@@ -23,7 +31,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   options: ToolsOzoneSettingDefs.Option[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

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

@@ -3,21 +3,26 @@
  */
 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 {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.setting.removeOptions'
 
 export interface QueryParams {}
 
 export interface InputSchema {
   keys: string[]
   scope: 'instance' | 'personal' | (string & {})
-  [k: string]: unknown
 }
 
-export interface OutputSchema {
-  [k: string]: unknown
-}
+export interface OutputSchema {}
 
 export interface CallOptions {
   signal?: AbortSignal

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

@@ -3,29 +3,35 @@
  */
 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 * as ToolsOzoneSettingDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneSettingDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+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,34 @@
  * 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 {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+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'
-  )
+const hashSigDetail = 'sigDetail'
+
+export function isSigDetail<V>(v: V) {
+  return is$typed(v, id, hashSigDetail)
+}
+
+export function validateSigDetail<V>(v: V) {
+  return validate<SigDetail & V>(v, id, hashSigDetail)
 }
 
-export function validateSigDetail(v: unknown): ValidationResult {
-  return lexicons.validate('tools.ozone.signature.defs#sigDetail', v)
+export function isValidSigDetail<V>(v: V) {
+  return isValid<SigDetail>(v, id, hashSigDetail)
 }

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

@@ -3,10 +3,18 @@
  */
 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 * as ToolsOzoneSignatureDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneSignatureDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.signature.findCorrelation'
 
 export interface QueryParams {
   dids: string[]
@@ -16,7 +24,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,11 +3,19 @@
  */
 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 * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
-import * as ToolsOzoneSignatureDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
+import type * as ToolsOzoneSignatureDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.signature.findRelatedAccounts'
 
 export interface QueryParams {
   did: string
@@ -20,7 +28,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   accounts: RelatedAccount[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {
@@ -39,22 +46,21 @@ 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'
-  )
+const hashRelatedAccount = 'relatedAccount'
+
+export function isRelatedAccount<V>(v: V) {
+  return is$typed(v, id, hashRelatedAccount)
+}
+
+export function validateRelatedAccount<V>(v: V) {
+  return validate<RelatedAccount & V>(v, id, hashRelatedAccount)
 }
 
-export function validateRelatedAccount(v: unknown): ValidationResult {
-  return lexicons.validate(
-    'tools.ozone.signature.findRelatedAccounts#relatedAccount',
-    v,
-  )
+export function isValidRelatedAccount<V>(v: V) {
+  return isValid<RelatedAccount>(v, id, hashRelatedAccount)
 }

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

@@ -3,10 +3,18 @@
  */
 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 * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ComAtprotoAdminDefs from '../../../com/atproto/admin/defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.signature.searchAccounts'
 
 export interface QueryParams {
   values: string[]
@@ -19,7 +27,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,10 +3,18 @@
  */
 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 * as ToolsOzoneTeamDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneTeamDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.team.addMember'
 
 export interface QueryParams {}
 
@@ -17,7 +25,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,21 @@
  * 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 AppBskyActorDefs from '../../../app/bsky/actor/defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as AppBskyActorDefs from '../../../app/bsky/actor/defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+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 +28,25 @@ 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'
-  )
+const hashMember = 'member'
+
+export function isMember<V>(v: V) {
+  return is$typed(v, id, hashMember)
+}
+
+export function validateMember<V>(v: V) {
+  return validate<Member & V>(v, id, hashMember)
 }
 
-export function validateMember(v: unknown): ValidationResult {
-  return lexicons.validate('tools.ozone.team.defs#member', v)
+export function isValidMember<V>(v: V) {
+  return isValid<Member>(v, id, hashMember)
 }
 
 /** 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,22 @@
  */
 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 {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+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,10 +3,18 @@
  */
 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 * as ToolsOzoneTeamDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneTeamDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.team.listMembers'
 
 export interface QueryParams {
   limit?: number
@@ -18,7 +26,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,10 +3,18 @@
  */
 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 * as ToolsOzoneTeamDefs from './defs'
+import {
+  isValid as _isValid,
+  validate as _validate,
+} from '../../../../lexicons'
+import { $Type, $Typed, is$typed as _is$typed, OmitKey } from '../../../../util'
+import type * as ToolsOzoneTeamDefs from './defs'
+
+const is$typed = _is$typed,
+  isValid = _isValid,
+  validate = _validate
+const id = 'tools.ozone.team.updateMember'
 
 export interface QueryParams {}
 
@@ -18,7 +26,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,62 @@
 /**
  * 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 isObject<V>(v: V): v is V & object {
+  return v != null && typeof v === 'object'
+}
+
+function check$type<Id extends string, Hash extends string>(
+  $type: unknown,
+  id: Id,
+  hash: Hash,
+): $type is $Type<Id, Hash> {
+  return $type === id
+    ? hash === 'main'
+    : // $type === `${id}#${hash}`
+      typeof $type === 'string' &&
+        $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: $Type<Id, Hash>
+}
+  ? V
+  : V extends { $type?: string }
+    ? V extends { $type?: $Type<Id, Hash> }
+      ? $Typed<V>
+      : never
+    : 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 isObject(v) && '$type' in v && check$type(v.$type, id, hash)
+}
+
+export function maybe$typed<V, Id extends string, Hash extends string>(
+  v: V,
+  id: Id,
+  hash: Hash,
+): v is V & object & { $type?: $Type<Id, Hash> } {
+  return (
+    isObject(v) &&
+    ('$type' in v
+      ? v.$type === undefined || check$type(v.$type, id, hash)
+      : true)
+  )
 }

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[])