@atproto/bsky 0.0.155 → 0.0.157

package/src/proto/bsync_pb.ts

@@ -736,14 +736,14 @@ export class Operation extends Message<Operation> {
   actorDid = ''
 
   /**
-   * @generated from field: string collection = 3;
+   * @generated from field: string namespace = 3;
    */
-  collection = ''
+  namespace = ''
 
   /**
-   * @generated from field: string rkey = 4;
+   * @generated from field: string key = 4;
    */
-  rkey = ''
+  key = ''
 
   /**
    * @generated from field: bsync.Method method = 5;
@@ -765,8 +765,8 @@ export class Operation extends Message<Operation> {
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: 'id', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
     { no: 2, name: 'actor_did', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
-    { no: 3, name: 'collection', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
-    { no: 4, name: 'rkey', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: 'namespace', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: 'key', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
     { no: 5, name: 'method', kind: 'enum', T: proto3.getEnumType(Method) },
     { no: 6, name: 'payload', kind: 'scalar', T: 12 /* ScalarType.BYTES */ },
   ])
@@ -805,19 +805,19 @@ export class Operation extends Message<Operation> {
  */
 export class PutOperationRequest extends Message<PutOperationRequest> {
   /**
-   * @generated from field: string collection = 1;
+   * @generated from field: string actor_did = 1;
    */
-  collection = ''
+  actorDid = ''
 
   /**
-   * @generated from field: string actor_did = 2;
+   * @generated from field: string namespace = 2;
    */
-  actorDid = ''
+  namespace = ''
 
   /**
-   * @generated from field: string rkey = 3;
+   * @generated from field: string key = 3;
    */
-  rkey = ''
+  key = ''
 
   /**
    * @generated from field: bsync.Method method = 4;
@@ -837,9 +837,9 @@ export class PutOperationRequest extends Message<PutOperationRequest> {
   static readonly runtime: typeof proto3 = proto3
   static readonly typeName = 'bsync.PutOperationRequest'
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
-    { no: 1, name: 'collection', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
-    { no: 2, name: 'actor_did', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
-    { no: 3, name: 'rkey', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 1, name: 'actor_did', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: 'namespace', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: 'key', kind: 'scalar', T: 9 /* ScalarType.STRING */ },
     { no: 4, name: 'method', kind: 'enum', T: proto3.getEnumType(Method) },
     { no: 5, name: 'payload', kind: 'scalar', T: 12 /* ScalarType.BYTES */ },
   ])

package/src/stash.ts

@@ -0,0 +1,75 @@
+import { LexValue, stringifyLex } from '@atproto/lexicon'
+import { BsyncClient } from './bsync'
+import { lexicons } from './lexicon/lexicons'
+import { Method } from './proto/bsync_pb'
+
+export const createStashClient = (bsyncClient: BsyncClient): StashClient => {
+  return new StashClient(bsyncClient)
+}
+
+// An abstraction over the BsyncClient, that uses the bsync `PutOperation` RPC
+// to store private data, which can be indexed by the dataplane and queried by the appview.
+export class StashClient {
+  constructor(private readonly bsyncClient: BsyncClient) {}
+
+  create(input: CreateInput) {
+    this.validateLexicon(input.namespace, input.payload)
+    return this.putOperation(Method.CREATE, input)
+  }
+
+  update(input: UpdateInput) {
+    this.validateLexicon(input.namespace, input.payload)
+    return this.putOperation(Method.UPDATE, input)
+  }
+
+  delete(input: DeleteInput) {
+    return this.putOperation(Method.DELETE, { ...input, payload: undefined })
+  }
+
+  private validateLexicon(namespace: string, payload: LexValue) {
+    const result = lexicons.validate(namespace, payload)
+    if (!result.success) {
+      throw result.error
+    }
+  }
+
+  private async putOperation(method: Method, input: PutOperationInput) {
+    const { actorDid, namespace, key, payload } = input
+    await this.bsyncClient.putOperation({
+      actorDid,
+      namespace,
+      key,
+      method,
+      payload: payload
+        ? Buffer.from(
+            stringifyLex({
+              $type: namespace,
+              ...payload,
+            }),
+          )
+        : undefined,
+    })
+  }
+}
+
+type PutOperationInput = {
+  actorDid: string
+  namespace: string
+  key: string
+  payload: LexValue | undefined
+}
+
+type CreateInput = {
+  actorDid: string
+  namespace: string
+  key: string
+  payload: LexValue
+}
+
+type UpdateInput = CreateInput
+
+type DeleteInput = {
+  actorDid: string
+  namespace: string
+  key: string
+}

package/src/views/index.ts

@@ -59,7 +59,7 @@ import {
   isRecord as isLabelerRecord,
 } from '../lexicon/types/app/bsky/labeler/service'
 import { RecordDeleted as NotificationRecordDeleted } from '../lexicon/types/app/bsky/notification/defs'
-import { ThreadHiddenItem } from '../lexicon/types/app/bsky/unspecced/getPostThreadHiddenV2'
+import { ThreadItem as ThreadOtherItem } from '../lexicon/types/app/bsky/unspecced/getPostThreadOtherV2'
 import {
   QueryParams as GetPostThreadV2QueryParams,
   ThreadItem,
@@ -75,13 +75,13 @@ import {
   uriToDid as creatorFromUri,
 } from '../util/uris'
 import {
-  ThreadHiddenAnchorPostNode,
-  ThreadHiddenItemValuePost,
-  ThreadHiddenPostNode,
   ThreadItemValueBlocked,
   ThreadItemValueNoUnauthenticated,
   ThreadItemValueNotFound,
   ThreadItemValuePost,
+  ThreadOtherAnchorPostNode,
+  ThreadOtherItemValuePost,
+  ThreadOtherPostNode,
   ThreadTree,
   ThreadTreeVisible,
   sortTrimFlattenThreadTree,
@@ -1161,7 +1161,7 @@ export class Views {
       prioritizeFollowedUsers: boolean
       sort: GetPostThreadV2QueryParams['sort']
     },
-  ): { hasHiddenReplies: boolean; thread: ThreadItem[] } {
+  ): { hasOtherReplies: boolean; thread: ThreadItem[] } {
     const { anchor: anchorUri, uris } = skeleton
 
     // Not found.
@@ -1169,7 +1169,7 @@ export class Views {
     const post = state.posts?.get(anchorUri)
     if (!post || !postView) {
       return {
-        hasHiddenReplies: false,
+        hasOtherReplies: false,
         thread: [
           this.threadV2ItemNotFound({
             uri: anchorUri,
@@ -1182,7 +1182,7 @@ export class Views {
     // Blocked (only 1p for anchor).
     if (this.viewerBlockExists(postView.author.did, state)) {
       return {
-        hasHiddenReplies: false,
+        hasOtherReplies: false,
         thread: [
           this.threadV2ItemBlocked({
             uri: anchorUri,
@@ -1229,7 +1229,7 @@ export class Views {
 
     const anchorDepth = 0 // The depth of the anchor post is always 0.
     let anchorTree: ThreadTree
-    let hasHiddenReplies = false
+    let hasOtherReplies = false
 
     if (this.noUnauthenticatedPost(state, postView)) {
       anchorTree = {
@@ -1241,7 +1241,7 @@ export class Views {
         parent,
       }
     } else {
-      const { replies, hasHiddenReplies: hasHiddenRepliesShadow } =
+      const { replies, hasOtherReplies: hasOtherRepliesShadow } =
         !anchorViolatesThreadGate
           ? this.threadV2Replies(
               {
@@ -1257,8 +1257,8 @@ export class Views {
               },
               state,
             )
-          : { replies: undefined, hasHiddenReplies: false }
-      hasHiddenReplies = hasHiddenRepliesShadow
+          : { replies: undefined, hasOtherReplies: false }
+      hasOtherReplies = hasOtherRepliesShadow
 
       anchorTree = {
         type: 'post',
@@ -1287,7 +1287,7 @@ export class Views {
     })
 
     return {
-      hasHiddenReplies,
+      hasOtherReplies,
       thread,
     }
   }
@@ -1432,14 +1432,14 @@ export class Views {
       prioritizeFollowedUsers: boolean
     },
     state: HydrationState,
-  ): { replies: ThreadTreeVisible[] | undefined; hasHiddenReplies: boolean } {
+  ): { replies: ThreadTreeVisible[] | undefined; hasOtherReplies: boolean } {
     // Reached the `below` limit.
     if (depth > below) {
-      return { replies: undefined, hasHiddenReplies: false }
+      return { replies: undefined, hasOtherReplies: false }
     }
 
     const childrenUris = childrenByParentUri[parentUri] ?? []
-    let hasHiddenReplies = false
+    let hasOtherReplies = false
     const replies = mapDefined(childrenUris, (uri) => {
       const replyInclusion = this.checkThreadV2ReplyInclusion({
         uri,
@@ -1452,14 +1452,14 @@ export class Views {
       const { authorDid, post, postView } = replyInclusion
 
       // Hidden.
-      const { isHidden } = this.isHiddenThreadPost(
+      const { isOther } = this.isOtherThreadPost(
         { post, postView, prioritizeFollowedUsers, rootUri, uri },
         state,
       )
-      if (isHidden) {
+      if (isOther) {
         // Only care about anchor replies
         if (depth === 1) {
-          hasHiddenReplies = true
+          hasOtherReplies = true
         }
         return undefined
       }
@@ -1504,7 +1504,7 @@ export class Views {
 
     return {
       replies,
-      hasHiddenReplies,
+      hasOtherReplies,
     }
   }
 
@@ -1537,8 +1537,8 @@ export class Views {
         moreParents: moreParents ?? false,
         moreReplies,
         opThread: isOPThread,
-        hiddenByThreadgate: false, // Hidden posts are handled by threadHiddenV2
-        mutedByViewer: false, // Hidden posts are handled by threadHiddenV2
+        hiddenByThreadgate: false, // Hidden posts are handled by threadOtherV2
+        mutedByViewer: false, // Hidden posts are handled by threadOtherV2
       },
     }
   }
@@ -1599,7 +1599,7 @@ export class Views {
     }
   }
 
-  threadHiddenV2(
+  threadOtherV2(
     skeleton: { anchor: string; uris: string[] },
     state: HydrationState,
     {
@@ -1611,7 +1611,7 @@ export class Views {
       branchingFactor: number
       prioritizeFollowedUsers: boolean
     },
-  ): ThreadHiddenItem[] {
+  ): ThreadOtherItem[] {
     const { anchor: anchorUri, uris } = skeleton
 
     // Not found.
@@ -1634,10 +1634,10 @@ export class Views {
     const rootUri = getRootUri(anchorUri, post)
     const opDid = uriToDid(rootUri)
 
-    const anchorTree: ThreadHiddenAnchorPostNode = {
+    const anchorTree: ThreadOtherAnchorPostNode = {
       type: 'hiddenAnchor',
-      item: this.threadHiddenV2ItemPostAnchor({ depth: 0, uri: anchorUri }),
-      replies: this.threadHiddenV2Replies(
+      item: this.threadOtherV2ItemPostAnchor({ depth: 0, uri: anchorUri }),
+      replies: this.threadOtherV2Replies(
         {
           parentUri: anchorUri,
           rootUri,
@@ -1660,7 +1660,7 @@ export class Views {
     })
   }
 
-  private threadHiddenV2Replies(
+  private threadOtherV2Replies(
     {
       parentUri,
       rootUri,
@@ -1677,7 +1677,7 @@ export class Views {
       prioritizeFollowedUsers: boolean
     },
     state: HydrationState,
-  ): ThreadHiddenPostNode[] | undefined {
+  ): ThreadOtherPostNode[] | undefined {
     // Reached the `below` limit.
     if (depth > below) {
       return undefined
@@ -1695,13 +1695,13 @@ export class Views {
       }
       const { post, postView } = replyInclusion
 
-      // Hidden.
-      const { isHidden, hiddenByThreadgate, mutedByViewer } =
-        this.isHiddenThreadPost(
+      // Other posts to pull out
+      const { isOther, hiddenByThreadgate, mutedByViewer } =
+        this.isOtherThreadPost(
           { post, postView, rootUri, prioritizeFollowedUsers, uri },
           state,
         )
-      if (isHidden) {
+      if (isOther) {
         // Only show hidden anchor replies, not all hidden.
         if (depth > 1) {
           return undefined
@@ -1712,7 +1712,7 @@ export class Views {
       }
 
       // Recurse down.
-      const replies = this.threadHiddenV2Replies(
+      const replies = this.threadOtherV2Replies(
         {
           parentUri: uri,
           rootUri,
@@ -1724,7 +1724,7 @@ export class Views {
         state,
       )
 
-      const item = this.threadHiddenV2ItemPost({
+      const item = this.threadOtherV2ItemPost({
         depth,
         hiddenByThreadgate,
         mutedByViewer,
@@ -1732,7 +1732,7 @@ export class Views {
         uri,
       })
 
-      const tree: ThreadHiddenPostNode = {
+      const tree: ThreadOtherPostNode = {
         type: 'hiddenPost',
         item: item,
         tags: post.tags,
@@ -1743,13 +1743,13 @@ export class Views {
     })
   }
 
-  private threadHiddenV2ItemPostAnchor({
+  private threadOtherV2ItemPostAnchor({
     depth,
     uri,
   }: {
     depth: number
     uri: string
-  }): ThreadHiddenAnchorPostNode['item'] {
+  }): ThreadOtherAnchorPostNode['item'] {
     return {
       uri,
       depth,
@@ -1759,7 +1759,7 @@ export class Views {
     }
   }
 
-  private threadHiddenV2ItemPost({
+  private threadOtherV2ItemPost({
     depth,
     hiddenByThreadgate,
     mutedByViewer,
@@ -1771,8 +1771,8 @@ export class Views {
     mutedByViewer: boolean
     postView: PostView
     uri: string
-  }): ThreadHiddenItemValuePost {
-    const base = this.threadHiddenV2ItemPostAnchor({ depth, uri })
+  }): ThreadOtherItemValuePost {
+    const base = this.threadOtherV2ItemPostAnchor({ depth, uri })
     return {
       ...base,
       value: {
@@ -1780,9 +1780,9 @@ export class Views {
         post: postView,
         hiddenByThreadgate,
         mutedByViewer,
-        moreParents: false, // Hidden replies don't have parents.
-        moreReplies: 0, // Hidden replies don't have replies hydrated.
-        opThread: false, // Hidden replies don't contain OP threads.
+        moreParents: false, // "Other" replies don't have parents.
+        moreReplies: 0, // "Other" replies don't have replies hydrated.
+        opThread: false, // "Other" replies don't contain OP threads.
       },
     }
   }
@@ -1834,7 +1834,7 @@ export class Views {
     return { authorDid, post, postView }
   }
 
-  private isHiddenThreadPost(
+  private isOtherThreadPost(
     {
       post,
       postView,
@@ -1850,7 +1850,7 @@ export class Views {
     },
     state: HydrationState,
   ): {
-    isHidden: boolean
+    isOther: boolean
     hiddenByTag: boolean
     hiddenByThreadgate: boolean
     mutedByViewer: boolean
@@ -1873,7 +1873,7 @@ export class Views {
     const mutedByViewer = this.viewerMuteExists(authorDid, state)
 
     return {
-      isHidden: hiddenByTag || hiddenByThreadgate || mutedByViewer,
+      isOther: hiddenByTag || hiddenByThreadgate || mutedByViewer,
       hiddenByTag,
       hiddenByThreadgate,
       mutedByViewer,

package/src/views/threads-v2.ts

@@ -7,18 +7,18 @@ import {
   ThreadItemNotFound,
   ThreadItemPost,
 } from '../lexicon/types/app/bsky/unspecced/defs'
-import { ThreadHiddenItem } from '../lexicon/types/app/bsky/unspecced/getPostThreadHiddenV2'
+import { ThreadItem as ThreadOtherItem } from '../lexicon/types/app/bsky/unspecced/getPostThreadOtherV2'
 import {
   QueryParams as GetPostThreadV2QueryParams,
   ThreadItem,
 } from '../lexicon/types/app/bsky/unspecced/getPostThreadV2'
 import { $Typed } from '../lexicon/util'
 
-type ThreadMaybeHiddenPostNode = ThreadPostNode | ThreadHiddenPostNode
+type ThreadMaybeOtherPostNode = ThreadPostNode | ThreadOtherPostNode
 type ThreadNodeWithReplies =
   | ThreadPostNode
-  | ThreadHiddenPostNode
-  | ThreadHiddenAnchorPostNode
+  | ThreadOtherPostNode
+  | ThreadOtherAnchorPostNode
 
 type ThreadItemValue<T extends ThreadItem['value']> = Omit<
   ThreadItem,
@@ -63,37 +63,37 @@ type ThreadPostNode = {
   replies: ThreadTree[] | undefined
 }
 
-type ThreadHiddenItemValue<T extends ThreadHiddenItem['value']> = Omit<
-  ThreadHiddenItem,
+type ThreadOtherItemValue<T extends ThreadOtherItem['value']> = Omit<
+  ThreadOtherItem,
   'value'
 > & {
   value: T
 }
 
-export type ThreadHiddenItemValuePost = ThreadHiddenItemValue<
+export type ThreadOtherItemValuePost = ThreadOtherItemValue<
   $Typed<ThreadItemPost>
 >
 
 // This is an intermediary type that doesn't map to the views.
 // It is useful to differentiate between the anchor post and the replies for the hidden case,
 // while also differentiating between hidden and visible cases.
-export type ThreadHiddenAnchorPostNode = {
+export type ThreadOtherAnchorPostNode = {
   type: 'hiddenAnchor'
-  item: Omit<ThreadHiddenItem, 'value'> & { value: undefined }
-  replies: ThreadHiddenPostNode[] | undefined
+  item: Omit<ThreadOtherItem, 'value'> & { value: undefined }
+  replies: ThreadOtherPostNode[] | undefined
 }
 
-export type ThreadHiddenPostNode = {
+export type ThreadOtherPostNode = {
   type: 'hiddenPost'
-  item: ThreadHiddenItemValuePost
+  item: ThreadOtherItemValuePost
   tags: Set<string>
-  replies: ThreadHiddenPostNode[] | undefined
+  replies: ThreadOtherPostNode[] | undefined
 }
 
 const isNodeWithReplies = (node: ThreadTree): node is ThreadNodeWithReplies =>
   'replies' in node && node.replies !== undefined
 
-const isPostNode = (node: ThreadTree): node is ThreadMaybeHiddenPostNode =>
+const isPostNode = (node: ThreadTree): node is ThreadMaybeOtherPostNode =>
   node.type === 'post' || node.type === 'hiddenPost'
 
 export type ThreadTreeVisible =
@@ -102,9 +102,9 @@ export type ThreadTreeVisible =
   | ThreadNotFoundNode
   | ThreadPostNode
 
-export type ThreadTreeHidden = ThreadHiddenAnchorPostNode | ThreadHiddenPostNode
+export type ThreadTreeOther = ThreadOtherAnchorPostNode | ThreadOtherPostNode
 
-export type ThreadTree = ThreadTreeVisible | ThreadTreeHidden
+export type ThreadTree = ThreadTreeVisible | ThreadTreeOther
 
 /** This function mutates the tree parameter. */
 export function sortTrimFlattenThreadTree(
@@ -146,8 +146,8 @@ function sortTrimThreadTree(
       if (!isPostNode(bn)) {
         return -1
       }
-      const aNode: ThreadMaybeHiddenPostNode = an
-      const bNode: ThreadMaybeHiddenPostNode = bn
+      const aNode: ThreadMaybeOtherPostNode = an
+      const bNode: ThreadMaybeOtherPostNode = bn
 
       // First applies bumping.
       const bump = applyBumping(aNode, bNode, opts)
@@ -171,8 +171,8 @@ function sortTrimThreadTree(
 }
 
 function applyBumping(
-  aNode: ThreadMaybeHiddenPostNode,
-  bNode: ThreadMaybeHiddenPostNode,
+  aNode: ThreadMaybeOtherPostNode,
+  bNode: ThreadMaybeOtherPostNode,
   opts: SortTrimFlattenOptions,
 ): number | null {
   if (!isPostNode(aNode)) {
@@ -191,7 +191,7 @@ function applyBumping(
   } = opts
 
   type BumpDirection = 'up' | 'down'
-  type BumpPredicateFn = (i: ThreadMaybeHiddenPostNode) => boolean
+  type BumpPredicateFn = (i: ThreadMaybeOtherPostNode) => boolean
 
   const maybeBump = (
     bump: BumpDirection,
@@ -276,8 +276,8 @@ function applyBumping(
 }
 
 function applySorting(
-  aNode: ThreadMaybeHiddenPostNode,
-  bNode: ThreadMaybeHiddenPostNode,
+  aNode: ThreadMaybeOtherPostNode,
+  bNode: ThreadMaybeOtherPostNode,
   opts: SortTrimFlattenOptions,
 ): number {
   const a = aNode.item.value