@atproto/api 0.13.20 → 0.14.0-next.0

package/src/client/types/app/bsky/actor/getPreferences.ts

@@ -3,18 +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 { $Type, $Typed, is$typed, OmitKey } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
 import * as AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.getPreferences'
+
 export interface QueryParams {}
 
 export type InputSchema = undefined
 
 export interface OutputSchema {
   preferences: AppBskyActorDefs.Preferences
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/actor/getProfile.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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.getProfile'
+
 export interface QueryParams {
   /** Handle or DID of account to fetch profile of. */
   actor: string

package/src/client/types/app/bsky/actor/getProfiles.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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.getProfiles'
+
 export interface QueryParams {
   actors: string[]
 }
@@ -16,7 +18,6 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   profiles: AppBskyActorDefs.ProfileViewDetailed[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/actor/getSuggestions.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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.getSuggestions'
+
 export interface QueryParams {
   limit?: number
   cursor?: string
@@ -18,7 +20,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   actors: AppBskyActorDefs.ProfileView[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/actor/profile.ts

@@ -2,13 +2,16 @@
  * 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 ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
 
+const id = 'app.bsky.actor.profile'
+
 export interface Record {
+  $type?: $Type<'app.bsky.actor.profile', 'main'>
   displayName?: string
   /** Free-form profile description text. */
   description?: string
@@ -16,24 +19,21 @@ export interface Record {
   avatar?: BlobRef
   /** Larger horizontal image to display behind profile view. */
   banner?: BlobRef
-  labels?:
-    | ComAtprotoLabelDefs.SelfLabels
-    | { $type: string; [k: string]: unknown }
+  labels?: $Typed<ComAtprotoLabelDefs.SelfLabels> | { $type: string }
   joinedViaStarterPack?: ComAtprotoRepoStrongRef.Main
   pinnedPost?: ComAtprotoRepoStrongRef.Main
   createdAt?: string
   [k: string]: unknown
 }
 
-export function isRecord(v: unknown): v is Record {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    (v.$type === 'app.bsky.actor.profile#main' ||
-      v.$type === 'app.bsky.actor.profile')
-  )
+export function isRecord<V>(v: V) {
+  return is$typed(v, id, 'main')
+}
+
+export function validateRecord(v: unknown) {
+  return lexicons.validate(`${id}#main`, v) as ValidationResult<Record>
 }
 
-export function validateRecord(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.actor.profile#main', v)
+export function isValidRecord<V>(v: V): v is V & $Typed<Record> {
+  return isRecord(v) && validateRecord(v).success
 }

package/src/client/types/app/bsky/actor/putPreferences.ts

@@ -3,16 +3,17 @@
  */
 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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.putPreferences'
+
 export interface QueryParams {}
 
 export interface InputSchema {
   preferences: AppBskyActorDefs.Preferences
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/actor/searchActors.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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.searchActors'
+
 export interface QueryParams {
   /** DEPRECATED: use 'q' instead. */
   term?: string
@@ -22,7 +24,6 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   actors: AppBskyActorDefs.ProfileView[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/actor/searchActorsTypeahead.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 AppBskyActorDefs from './defs'
 
+const id = 'app.bsky.actor.searchActorsTypeahead'
+
 export interface QueryParams {
   /** DEPRECATED: use 'q' instead. */
   term?: string
@@ -20,7 +22,6 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   actors: AppBskyActorDefs.ProfileViewBasic[]
-  [k: string]: unknown
 }
 
 export interface CallOptions {

package/src/client/types/app/bsky/embed/defs.ts

@@ -2,25 +2,30 @@
  * 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 = 'app.bsky.embed.defs'
 
 /** width:height represents an aspect ratio. It may be approximate, and may not correspond to absolute dimensions in any given unit. */
 export interface AspectRatio {
+  $type?: $Type<'app.bsky.embed.defs', 'aspectRatio'>
   width: number
   height: number
-  [k: string]: unknown
 }
 
-export function isAspectRatio(v: unknown): v is AspectRatio {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'app.bsky.embed.defs#aspectRatio'
-  )
+export function isAspectRatio<V>(v: V) {
+  return is$typed(v, id, 'aspectRatio')
+}
+
+export function validateAspectRatio(v: unknown) {
+  return lexicons.validate(
+    `${id}#aspectRatio`,
+    v,
+  ) as ValidationResult<AspectRatio>
 }
 
-export function validateAspectRatio(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.defs#aspectRatio', v)
+export function isValidAspectRatio<V>(v: V): v is V & $Typed<AspectRatio> {
+  return isAspectRatio(v) && validateAspectRatio(v).success
 }

package/src/client/types/app/bsky/embed/external.ts

@@ -2,82 +2,86 @@
  * 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 = 'app.bsky.embed.external'
 
 /** A representation of some externally linked content (eg, a URL and 'card'), embedded in a Bluesky record (eg, a post). */
 export interface Main {
+  $type?: $Type<'app.bsky.embed.external', 'main'>
   external: External
-  [k: string]: unknown
 }
 
-export function isMain(v: unknown): v is Main {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    (v.$type === 'app.bsky.embed.external#main' ||
-      v.$type === 'app.bsky.embed.external')
-  )
+export function isMain<V>(v: V) {
+  return is$typed(v, id, 'main')
 }
 
-export function validateMain(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.external#main', v)
+export function validateMain(v: unknown) {
+  return lexicons.validate(`${id}#main`, v) as ValidationResult<Main>
+}
+
+export function isValidMain<V>(v: V): v is V & $Typed<Main> {
+  return isMain(v) && validateMain(v).success
 }
 
 export interface External {
+  $type?: $Type<'app.bsky.embed.external', 'external'>
   uri: string
   title: string
   description: string
   thumb?: BlobRef
-  [k: string]: unknown
 }
 
-export function isExternal(v: unknown): v is External {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'app.bsky.embed.external#external'
-  )
+export function isExternal<V>(v: V) {
+  return is$typed(v, id, 'external')
 }
 
-export function validateExternal(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.external#external', v)
+export function validateExternal(v: unknown) {
+  return lexicons.validate(`${id}#external`, v) as ValidationResult<External>
+}
+
+export function isValidExternal<V>(v: V): v is V & $Typed<External> {
+  return isExternal(v) && validateExternal(v).success
 }
 
 export interface View {
+  $type?: $Type<'app.bsky.embed.external', 'view'>
   external: ViewExternal
-  [k: string]: unknown
 }
 
-export function isView(v: unknown): v is View {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'app.bsky.embed.external#view'
-  )
+export function isView<V>(v: V) {
+  return is$typed(v, id, 'view')
+}
+
+export function validateView(v: unknown) {
+  return lexicons.validate(`${id}#view`, v) as ValidationResult<View>
 }
 
-export function validateView(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.external#view', v)
+export function isValidView<V>(v: V): v is V & $Typed<View> {
+  return isView(v) && validateView(v).success
 }
 
 export interface ViewExternal {
+  $type?: $Type<'app.bsky.embed.external', 'viewExternal'>
   uri: string
   title: string
   description: string
   thumb?: string
-  [k: string]: unknown
 }
 
-export function isViewExternal(v: unknown): v is ViewExternal {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'app.bsky.embed.external#viewExternal'
-  )
+export function isViewExternal<V>(v: V) {
+  return is$typed(v, id, 'viewExternal')
+}
+
+export function validateViewExternal(v: unknown) {
+  return lexicons.validate(
+    `${id}#viewExternal`,
+    v,
+  ) as ValidationResult<ViewExternal>
 }
 
-export function validateViewExternal(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.external#viewExternal', v)
+export function isValidViewExternal<V>(v: V): v is V & $Typed<ViewExternal> {
+  return isViewExternal(v) && validateViewExternal(v).success
 }

package/src/client/types/app/bsky/embed/images.ts

@@ -2,63 +2,69 @@
  * 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 AppBskyEmbedDefs from './defs'
 
+const id = 'app.bsky.embed.images'
+
 export interface Main {
+  $type?: $Type<'app.bsky.embed.images', 'main'>
   images: Image[]
-  [k: string]: unknown
 }
 
-export function isMain(v: unknown): v is Main {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    (v.$type === 'app.bsky.embed.images#main' ||
-      v.$type === 'app.bsky.embed.images')
-  )
+export function isMain<V>(v: V) {
+  return is$typed(v, id, 'main')
 }
 
-export function validateMain(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.images#main', v)
+export function validateMain(v: unknown) {
+  return lexicons.validate(`${id}#main`, v) as ValidationResult<Main>
+}
+
+export function isValidMain<V>(v: V): v is V & $Typed<Main> {
+  return isMain(v) && validateMain(v).success
 }
 
 export interface Image {
+  $type?: $Type<'app.bsky.embed.images', 'image'>
   image: BlobRef
   /** Alt text description of the image, for accessibility. */
   alt: string
   aspectRatio?: AppBskyEmbedDefs.AspectRatio
-  [k: string]: unknown
 }
 
-export function isImage(v: unknown): v is Image {
-  return (
-    isObj(v) && hasProp(v, '$type') && v.$type === 'app.bsky.embed.images#image'
-  )
+export function isImage<V>(v: V) {
+  return is$typed(v, id, 'image')
 }
 
-export function validateImage(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.images#image', v)
+export function validateImage(v: unknown) {
+  return lexicons.validate(`${id}#image`, v) as ValidationResult<Image>
+}
+
+export function isValidImage<V>(v: V): v is V & $Typed<Image> {
+  return isImage(v) && validateImage(v).success
 }
 
 export interface View {
+  $type?: $Type<'app.bsky.embed.images', 'view'>
   images: ViewImage[]
-  [k: string]: unknown
 }
 
-export function isView(v: unknown): v is View {
-  return (
-    isObj(v) && hasProp(v, '$type') && v.$type === 'app.bsky.embed.images#view'
-  )
+export function isView<V>(v: V) {
+  return is$typed(v, id, 'view')
+}
+
+export function validateView(v: unknown) {
+  return lexicons.validate(`${id}#view`, v) as ValidationResult<View>
 }
 
-export function validateView(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.images#view', v)
+export function isValidView<V>(v: V): v is V & $Typed<View> {
+  return isView(v) && validateView(v).success
 }
 
 export interface ViewImage {
+  $type?: $Type<'app.bsky.embed.images', 'viewImage'>
   /** Fully-qualified URL where a thumbnail of the image can be fetched. For example, CDN location provided by the App View. */
   thumb: string
   /** Fully-qualified URL where a large version of the image can be fetched. May or may not be the exact original blob. For example, CDN location provided by the App View. */
@@ -66,17 +72,16 @@ export interface ViewImage {
   /** Alt text description of the image, for accessibility. */
   alt: string
   aspectRatio?: AppBskyEmbedDefs.AspectRatio
-  [k: string]: unknown
 }
 
-export function isViewImage(v: unknown): v is ViewImage {
-  return (
-    isObj(v) &&
-    hasProp(v, '$type') &&
-    v.$type === 'app.bsky.embed.images#viewImage'
-  )
+export function isViewImage<V>(v: V) {
+  return is$typed(v, id, 'viewImage')
+}
+
+export function validateViewImage(v: unknown) {
+  return lexicons.validate(`${id}#viewImage`, v) as ValidationResult<ViewImage>
 }
 
-export function validateViewImage(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.embed.images#viewImage', v)
+export function isValidViewImage<V>(v: V): v is V & $Typed<ViewImage> {
+  return isViewImage(v) && validateViewImage(v).success
 }