@atproto/bsky 0.0.115 → 0.0.117

package/src/lexicon/util.ts

@@ -1,13 +1,82 @@
 /**
  * GENERATED CODE - DO NOT MODIFY
  */
-export function isObj(v: unknown): v is Record<string, unknown> {
-  return typeof v === 'object' && v !== null
+
+import { ValidationResult } from '@atproto/lexicon'
+
+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, T extends string = string> = V & { $type: T }
+export type Un$Typed<V extends { $type?: string }> = OmitKey<V, '$type'>
+
+export type $Type<Id extends string, Hash extends string> = Hash extends 'main'
+  ? Id
+  : `${Id}#${Hash}`
+
+function isObject<V>(v: V): v is V & object {
+  return v != null && typeof v === 'object'
+}
+
+function is$type<Id extends string, Hash extends string>(
+  $type: unknown,
+  id: Id,
+  hash: Hash,
+): $type is $Type<Id, Hash> {
+  return hash === 'main'
+    ? $type === id
+    : // $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 $TypedObject<
+  V,
+  Id extends string,
+  Hash extends string,
+> = V extends {
+  $type: $Type<Id, Hash>
+}
+  ? V
+  : V extends { $type?: string }
+    ? V extends { $type?: infer T extends $Type<Id, Hash> }
+      ? V & { $type: T }
+      : 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 $TypedObject<V, Id, Hash> {
+  return isObject(v) && '$type' in v && is$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 || is$type(v.$type, id, hash) : true)
+  )
+}
+
+export type Validator<R = unknown> = (v: unknown) => ValidationResult<R>
+export type ValidatorParam<V extends Validator> =
+  V extends Validator<infer R> ? R : never
+
+/**
+ * Utility function that allows to convert a "validate*" utility function into a
+ * type predicate.
+ */
+export function asPredicate<V extends Validator>(validate: V) {
+  return function <T>(v: T): v is T & ValidatorParam<V> {
+    return validate(v).success
+  }
 }

package/src/views/index.ts

@@ -1,18 +1,24 @@
 import { mapDefined } from '@atproto/common'
 import { AtUri, INVALID_HANDLE, normalizeDatetimeAlways } from '@atproto/syntax'
 import { ProfileViewerState } from '../hydration/actor'
-import { FeedItem, Post, Repost } from '../hydration/feed'
+import { FeedItem, Like, Post, Repost } from '../hydration/feed'
+import { Follow } from '../hydration/graph'
 import { HydrationState } from '../hydration/hydrator'
 import { Label } from '../hydration/label'
 import { RecordInfo } from '../hydration/util'
 import { ImageUriBuilder } from '../image/uri'
 import { ids } from '../lexicon/lexicons'
 import {
+  KnownFollowers,
   ProfileView,
   ProfileViewBasic,
   ProfileViewDetailed,
   ViewerState as ProfileViewer,
 } from '../lexicon/types/app/bsky/actor/defs'
+import {
+  Record as ProfileRecord,
+  isRecord as isProfileRecord,
+} from '../lexicon/types/app/bsky/actor/profile'
 import {
   BlockedPost,
   FeedViewPost,
@@ -26,7 +32,12 @@ import {
   ThreadgateView,
   isPostView,
 } from '../lexicon/types/app/bsky/feed/defs'
-import { isRecord as isPostRecord } from '../lexicon/types/app/bsky/feed/post'
+import { Record as LikeRecord } from '../lexicon/types/app/bsky/feed/like'
+import {
+  Record as PostRecord,
+  isRecord as isPostRecord,
+} from '../lexicon/types/app/bsky/feed/post'
+import { Record as RepostRecord } from '../lexicon/types/app/bsky/feed/repost'
 import { isListRule } from '../lexicon/types/app/bsky/feed/threadgate'
 import {
   ListView,
@@ -34,11 +45,17 @@ import {
   StarterPackView,
   StarterPackViewBasic,
 } from '../lexicon/types/app/bsky/graph/defs'
+import { Record as FollowRecord } from '../lexicon/types/app/bsky/graph/follow'
 import {
   LabelerView,
   LabelerViewDetailed,
 } from '../lexicon/types/app/bsky/labeler/defs'
+import {
+  Record as LabelerRecord,
+  isRecord as isLabelerRecord,
+} from '../lexicon/types/app/bsky/labeler/service'
 import { isSelfLabels } from '../lexicon/types/com/atproto/label/defs'
+import { $Typed, Un$Typed } from '../lexicon/util'
 import { Notification } from '../proto/bsky_pb'
 import {
   postUriToPostgateUri,
@@ -181,7 +198,7 @@ export class Views {
   profileDetailed(
     did: string,
     state: HydrationState,
-  ): ProfileViewDetailed | undefined {
+  ): Un$Typed<ProfileViewDetailed> | undefined {
     const actor = state.actors?.get(did)
     if (!actor) return
     const baseView = this.profile(did, state)
@@ -223,7 +240,10 @@ export class Views {
     }
   }
 
-  profile(did: string, state: HydrationState): ProfileView | undefined {
+  profile(
+    did: string,
+    state: HydrationState,
+  ): Un$Typed<ProfileView> | undefined {
     const actor = state.actors?.get(did)
     if (!actor) return
     const basicView = this.profileBasic(did, state)
@@ -244,7 +264,7 @@ export class Views {
   profileBasic(
     did: string,
     state: HydrationState,
-  ): ProfileViewBasic | undefined {
+  ): Un$Typed<ProfileViewBasic> | undefined {
     const actor = state.actors?.get(did)
     if (!actor) return
     const profileUri = AtUri.make(
@@ -332,7 +352,10 @@ export class Views {
     }
   }
 
-  knownFollowers(did: string, state: HydrationState) {
+  knownFollowers(
+    did: string,
+    state: HydrationState,
+  ): KnownFollowers | undefined {
     const knownFollowers = state.knownFollowers?.get(did)
     if (!knownFollowers) return
     const blocks = state.bidirectionalBlocks?.get(did)
@@ -369,7 +392,7 @@ export class Views {
   // Graph
   // ------------
 
-  list(uri: string, state: HydrationState): ListView | undefined {
+  list(uri: string, state: HydrationState): Un$Typed<ListView> | undefined {
     const creatorDid = creatorFromUri(uri)
     const list = state.lists?.get(uri)
     if (!list) return
@@ -387,7 +410,10 @@ export class Views {
     }
   }
 
-  listBasic(uri: string, state: HydrationState): ListViewBasic | undefined {
+  listBasic(
+    uri: string,
+    state: HydrationState,
+  ): Un$Typed<ListViewBasic> | undefined {
     const list = state.lists?.get(uri)
     if (!list) {
       return undefined
@@ -423,7 +449,7 @@ export class Views {
   starterPackBasic(
     uri: string,
     state: HydrationState,
-  ): StarterPackViewBasic | undefined {
+  ): Un$Typed<StarterPackViewBasic> | undefined {
     const sp = state.starterPacks?.get(uri)
     if (!sp) return
     const parsedUri = new AtUri(uri)
@@ -443,7 +469,10 @@ export class Views {
     }
   }
 
-  starterPack(uri: string, state: HydrationState): StarterPackView | undefined {
+  starterPack(
+    uri: string,
+    state: HydrationState,
+  ): Un$Typed<StarterPackView> | undefined {
     const sp = state.starterPacks?.get(uri)
     const basicView = this.starterPackBasic(uri, state)
     if (!sp || !basicView) return
@@ -470,14 +499,37 @@ export class Views {
   // Labels
   // ------------
 
-  selfLabels(details: {
+  selfLabels({
+    uri,
+    cid,
+    record,
+  }: {
     uri?: string
     cid?: string
-    record?: Record<string, unknown>
+    record?:
+      | PostRecord
+      | LikeRecord
+      | RepostRecord
+      | FollowRecord
+      | ProfileRecord
+      | LabelerRecord
   }): Label[] {
-    const { uri, cid, record } = details
     if (!uri || !cid || !record) return []
-    if (!isSelfLabels(record.labels)) return []
+
+    // Only these have a "labels" property:
+    if (
+      !isPostRecord(record) &&
+      !isProfileRecord(record) &&
+      !isLabelerRecord(record)
+    ) {
+      return []
+    }
+
+    // Ignore if no labels defines
+    if (!isSelfLabels(record.labels) || !record.labels.values.length) {
+      return []
+    }
+
     const src = creatorFromUri(uri) // record creator
     const cts =
       typeof record.createdAt === 'string'
@@ -488,7 +540,10 @@ export class Views {
     })
   }
 
-  labeler(did: string, state: HydrationState): LabelerView | undefined {
+  labeler(
+    did: string,
+    state: HydrationState,
+  ): Un$Typed<LabelerView> | undefined {
     const labeler = state.labelers?.get(did)
     if (!labeler) return
     const creator = this.profile(did, state)
@@ -524,7 +579,7 @@ export class Views {
   labelerDetailed(
     did: string,
     state: HydrationState,
-  ): LabelerViewDetailed | undefined {
+  ): Un$Typed<LabelerViewDetailed> | undefined {
     const baseView = this.labeler(did, state)
     if (!baseView) return
     const record = state.labelers?.get(did)
@@ -572,7 +627,10 @@ export class Views {
     }
   }
 
-  feedGenerator(uri: string, state: HydrationState): GeneratorView | undefined {
+  feedGenerator(
+    uri: string,
+    state: HydrationState,
+  ): Un$Typed<GeneratorView> | undefined {
     const feedgen = state.feedgens?.get(uri)
     if (!feedgen) return
     const creatorDid = creatorFromUri(uri)
@@ -609,7 +667,10 @@ export class Views {
     }
   }
 
-  threadgate(uri: string, state: HydrationState): ThreadgateView | undefined {
+  threadgate(
+    uri: string,
+    state: HydrationState,
+  ): Un$Typed<ThreadgateView> | undefined {
     const gate = state.threadgates?.get(uri)
     if (!gate) return
     return {
@@ -623,7 +684,11 @@ export class Views {
     }
   }
 
-  post(uri: string, state: HydrationState, depth = 0): PostView | undefined {
+  post(
+    uri: string,
+    state: HydrationState,
+    depth = 0,
+  ): Un$Typed<PostView> | undefined {
     const post = state.posts?.get(uri)
     if (!post) return
     const parsedUri = new AtUri(uri)
@@ -675,9 +740,9 @@ export class Views {
   feedViewPost(
     item: FeedItem,
     state: HydrationState,
-  ): FeedViewPost | undefined {
+  ): Un$Typed<FeedViewPost> | undefined {
     const postInfo = state.posts?.get(item.post.uri)
-    let reason: ReasonRepost | ReasonPin | undefined
+    let reason: $Typed<ReasonRepost> | $Typed<ReasonPin> | undefined
     if (item.authorPinned) {
       reason = this.reasonPin()
     } else if (item.repost) {
@@ -699,7 +764,7 @@ export class Views {
     }
   }
 
-  replyRef(uri: string, state: HydrationState): ReplyRef | undefined {
+  replyRef(uri: string, state: HydrationState): Un$Typed<ReplyRef> | undefined {
     const postRecord = state.posts?.get(uri.toString())?.record
     if (!postRecord?.reply) return
     let root = this.maybePost(postRecord.reply.root.uri, state)
@@ -717,8 +782,13 @@ export class Views {
       }
     }
     let grandparentAuthor: ProfileViewBasic | undefined
-    if (isPostRecord(parent.record) && parent.record.reply) {
+    if (
+      isPostView(parent) &&
+      isPostRecord(parent.record) &&
+      parent.record.reply
+    ) {
       grandparentAuthor = this.profileBasic(
+        // @ts-expect-error isValidPostRecord(parent.record) should be used but the "parent" is not IPDL decoded
         creatorFromUri(parent.record.reply.parent.uri),
         state,
       )
@@ -730,7 +800,7 @@ export class Views {
     }
   }
 
-  maybePost(uri: string, state: HydrationState): MaybePostView {
+  maybePost(uri: string, state: HydrationState): $Typed<MaybePostView> {
     const post = this.post(uri, state)
     if (!post) {
       return this.notFoundPost(uri)
@@ -739,8 +809,8 @@ export class Views {
       return this.blockedPost(uri, post.author.did, state)
     }
     return {
-      $type: 'app.bsky.feed.defs#postView',
       ...post,
+      $type: 'app.bsky.feed.defs#postView',
     }
   }
 
@@ -748,7 +818,7 @@ export class Views {
     uri: string,
     authorDid: string,
     state: HydrationState,
-  ): BlockedPost {
+  ): $Typed<BlockedPost> {
     return {
       $type: 'app.bsky.feed.defs#blockedPost',
       uri,
@@ -760,7 +830,7 @@ export class Views {
     }
   }
 
-  notFoundPost(uri: string): NotFoundPost {
+  notFoundPost(uri: string): $Typed<NotFoundPost> {
     return {
       $type: 'app.bsky.feed.defs#notFoundPost',
       uri,
@@ -772,7 +842,7 @@ export class Views {
     creatorDid: string,
     repost: Repost,
     state: HydrationState,
-  ): ReasonRepost | undefined {
+  ): $Typed<ReasonRepost> | undefined {
     const creator = this.profileBasic(creatorDid, state)
     if (!creator) return
     return {
@@ -782,7 +852,7 @@ export class Views {
     }
   }
 
-  reasonPin() {
+  reasonPin(): $Typed<ReasonPin> {
     return {
       $type: 'app.bsky.feed.defs#reasonPin',
     }
@@ -795,7 +865,7 @@ export class Views {
     skele: { anchor: string; uris: string[] },
     state: HydrationState,
     opts: { height: number; depth: number },
-  ): ThreadViewPost | NotFoundPost | BlockedPost {
+  ): $Typed<ThreadViewPost> | $Typed<NotFoundPost> | $Typed<BlockedPost> {
     const { anchor, uris } = skele
     const post = this.post(anchor, state)
     const postInfo = state.posts?.get(anchor)
@@ -843,7 +913,11 @@ export class Views {
     rootUri: string,
     state: HydrationState,
     height: number,
-  ): ThreadViewPost | NotFoundPost | BlockedPost | undefined {
+  ):
+    | $Typed<ThreadViewPost>
+    | $Typed<NotFoundPost>
+    | $Typed<BlockedPost>
+    | undefined {
     if (height < 1) return undefined
     const parentUri = state.posts?.get(childUri)?.record.reply?.parent.uri
     if (!parentUri) return undefined
@@ -876,7 +950,7 @@ export class Views {
     childrenByParentUri: Record<string, string[]>,
     state: HydrationState,
     depth: number,
-  ): (ThreadViewPost | BlockedPost)[] | undefined {
+  ): ($Typed<ThreadViewPost> | $Typed<BlockedPost>)[] | undefined {
     if (depth < 1) return undefined
     const childrenUris = childrenByParentUri[parentUri] ?? []
     return mapDefined(childrenUris, (uri) => {
@@ -926,7 +1000,7 @@ export class Views {
     embed: Embed | { $type: string },
     state: HydrationState,
     depth: number,
-  ): EmbedView | undefined {
+  ): $Typed<EmbedView> | undefined {
     if (isImagesEmbed(embed)) {
       return this.imagesEmbed(creatorFromUri(postUri), embed)
     } else if (isVideoEmbed(embed)) {
@@ -942,7 +1016,7 @@ export class Views {
     }
   }
 
-  imagesEmbed(did: string, embed: ImagesEmbed): ImagesEmbedView {
+  imagesEmbed(did: string, embed: ImagesEmbed): $Typed<ImagesEmbedView> {
     const imgViews = embed.images.map((img) => ({
       thumb: this.imgUriBuilder.getPresetUri(
         'feed_thumbnail',
@@ -963,7 +1037,7 @@ export class Views {
     }
   }
 
-  videoEmbed(did: string, embed: VideoEmbed): VideoEmbedView {
+  videoEmbed(did: string, embed: VideoEmbed): $Typed<VideoEmbedView> {
     const cid = cidFromBlobJson(embed.video)
     return {
       $type: 'app.bsky.embed.video#view',
@@ -975,7 +1049,7 @@ export class Views {
     }
   }
 
-  externalEmbed(did: string, embed: ExternalEmbed): ExternalEmbedView {
+  externalEmbed(did: string, embed: ExternalEmbed): $Typed<ExternalEmbedView> {
     const { uri, title, description, thumb } = embed.external
     return {
       $type: 'app.bsky.embed.external#view',
@@ -994,7 +1068,10 @@ export class Views {
     }
   }
 
-  embedNotFound(uri: string): { $type: string; record: EmbedNotFound } {
+  embedNotFound(uri: string): {
+    $type: 'app.bsky.embed.record#view'
+    record: $Typed<EmbedNotFound>
+  } {
     return {
       $type: 'app.bsky.embed.record#view',
       record: {
@@ -1005,7 +1082,10 @@ export class Views {
     }
   }
 
-  embedDetached(uri: string): { $type: string; record: EmbedDetached } {
+  embedDetached(uri: string): {
+    $type: 'app.bsky.embed.record#view'
+    record: $Typed<EmbedDetached>
+  } {
     return {
       $type: 'app.bsky.embed.record#view',
       record: {
@@ -1019,7 +1099,10 @@ export class Views {
   embedBlocked(
     uri: string,
     state: HydrationState,
-  ): { $type: string; record: EmbedBlocked } {
+  ): {
+    $type: 'app.bsky.embed.record#view'
+    record: $Typed<EmbedBlocked>
+  } {
     const creator = creatorFromUri(uri)
     return {
       $type: 'app.bsky.embed.record#view',
@@ -1039,7 +1122,7 @@ export class Views {
     uri: string,
     state: HydrationState,
     depth: number,
-  ): PostEmbedView | undefined {
+  ): $Typed<PostEmbedView> | undefined {
     const postView = this.post(uri, state, depth)
     if (!postView) return
     return {
@@ -1058,6 +1141,20 @@ export class Views {
     }
   }
 
+  recordEmbed(
+    postUri: string,
+    embed: RecordEmbed,
+    state: HydrationState,
+    depth: number,
+    withTypeTag: false,
+  ): RecordEmbedView
+  recordEmbed(
+    postUri: string,
+    embed: RecordEmbed,
+    state: HydrationState,
+    depth: number,
+    withTypeTag?: true,
+  ): $Typed<RecordEmbedView>
   recordEmbed(
     postUri: string,
     embed: RecordEmbed,
@@ -1091,35 +1188,43 @@ export class Views {
     } else if (parsedUri.collection === ids.AppBskyFeedGenerator) {
       const view = this.feedGenerator(uri, state)
       if (!view) return this.embedNotFound(uri)
-      view.$type = 'app.bsky.feed.defs#generatorView'
-      return this.recordEmbedWrapper(view, withTypeTag)
+      return this.recordEmbedWrapper(
+        { ...view, $type: 'app.bsky.feed.defs#generatorView' },
+        withTypeTag,
+      )
     } else if (parsedUri.collection === ids.AppBskyGraphList) {
       const view = this.list(uri, state)
       if (!view) return this.embedNotFound(uri)
-      view.$type = 'app.bsky.graph.defs#listView'
-      return this.recordEmbedWrapper(view, withTypeTag)
+      return this.recordEmbedWrapper(
+        { ...view, $type: 'app.bsky.graph.defs#listView' },
+        withTypeTag,
+      )
     } else if (parsedUri.collection === ids.AppBskyLabelerService) {
       const view = this.labeler(parsedUri.hostname, state)
       if (!view) return this.embedNotFound(uri)
-      view.$type = 'app.bsky.labeler.defs#labelerView'
-      return this.recordEmbedWrapper(view, withTypeTag)
+      return this.recordEmbedWrapper(
+        { ...view, $type: 'app.bsky.labeler.defs#labelerView' },
+        withTypeTag,
+      )
     } else if (parsedUri.collection === ids.AppBskyGraphStarterpack) {
       const view = this.starterPackBasic(uri, state)
       if (!view) return this.embedNotFound(uri)
-      view.$type = 'app.bsky.graph.defs#starterPackViewBasic'
-      return this.recordEmbedWrapper(view, withTypeTag)
+      return this.recordEmbedWrapper(
+        { ...view, $type: 'app.bsky.graph.defs#starterPackViewBasic' },
+        withTypeTag,
+      )
     }
     return this.embedNotFound(uri)
   }
 
-  private recordEmbedWrapper(
-    record: RecordEmbedViewInternal,
+  private recordEmbedWrapper<T extends $Typed<RecordEmbedViewInternal>>(
+    record: T,
     withTypeTag: boolean,
-  ): RecordEmbedView {
+  ) {
     return {
-      $type: withTypeTag ? 'app.bsky.embed.record#view' : undefined,
+      $type: withTypeTag ? ('app.bsky.embed.record#view' as const) : undefined,
       record,
-    }
+    } satisfies RecordEmbedView
   }
 
   recordWithMediaEmbed(
@@ -1127,9 +1232,12 @@ export class Views {
     embed: RecordWithMedia,
     state: HydrationState,
     depth: number,
-  ): RecordWithMediaView | undefined {
+  ): $Typed<RecordWithMediaView> | undefined {
     const creator = creatorFromUri(postUri)
-    let mediaEmbed: ImagesEmbedView | VideoEmbedView | ExternalEmbedView
+    let mediaEmbed:
+      | $Typed<ImagesEmbedView>
+      | $Typed<VideoEmbedView>
+      | $Typed<ExternalEmbedView>
     if (isImagesEmbed(embed.media)) {
       mediaEmbed = this.imagesEmbed(creator, embed.media)
     } else if (isVideoEmbed(embed.media)) {
@@ -1222,13 +1330,22 @@ export class Views {
     notif: Notification,
     lastSeenAt: string | undefined,
     state: HydrationState,
-  ): NotificationView | undefined {
+  ): Un$Typed<NotificationView> | undefined {
     if (!notif.timestamp || !notif.reason) return
     const uri = new AtUri(notif.uri)
     const authorDid = uri.hostname
     const author = this.profile(authorDid, state)
     if (!author) return
-    let recordInfo: RecordInfo<Record<string, unknown>> | null | undefined
+
+    let recordInfo:
+      | Post
+      | Like
+      | Repost
+      | Follow
+      | RecordInfo<ProfileRecord>
+      | undefined
+      | null
+
     if (uri.collection === ids.AppBskyFeedPost) {
       recordInfo = state.posts?.get(notif.uri)
     } else if (uri.collection === ids.AppBskyFeedLike) {
@@ -1248,9 +1365,10 @@ export class Views {
               indexedAt: actor.indexedAt ?? new Date(0), // @NOTE will be present since profile record is present
               takedownRef: actor.profileTakedownRef,
             }
-          : null
+          : undefined
     }
     if (!recordInfo) return
+
     const labels = state.labels?.getBySubject(notif.uri) ?? []
     const selfLabels = this.selfLabels({
       uri: notif.uri,

package/src/views/types.ts

@@ -25,7 +25,10 @@ import {
   NotFoundPost,
   PostView,
 } from '../lexicon/types/app/bsky/feed/defs'
-import { ListView } from '../lexicon/types/app/bsky/graph/defs'
+import {
+  ListView,
+  StarterPackViewBasic,
+} from '../lexicon/types/app/bsky/graph/defs'
 import { LabelerView } from '../lexicon/types/app/bsky/labeler/defs'
 
 export type {
@@ -89,3 +92,4 @@ export type RecordEmbedViewInternal =
   | GeneratorView
   | ListView
   | LabelerView
+  | StarterPackViewBasic