Merge pull request #684 from bluesky-social/lex/optional-agg-fields

Lexicon: optional aggregated fields on views
bluesky-social · Mar 18, 2023 · bb02c10 · bb02c10
2 parents f4d3869 + e1e2d22
commit bb02c10
Show file tree

Hide file tree

Showing 15 changed files with 32 additions and 199 deletions.
diff --git a/lexicons/app/bsky/actor/defs.json b/lexicons/app/bsky/actor/defs.json
@@ -19,7 +19,7 @@
     },
     "profileView": {
       "type": "object",
-      "required": ["did", "handle", "creator", "followersCount", "followsCount", "postsCount"],
+      "required": ["did", "handle", "creator"],
       "properties": {
         "did": {"type": "string", "format": "did"},
         "handle": {"type": "string"},
@@ -38,8 +38,7 @@
         "postsCount": {"type": "integer"},
         "creator": {"type": "string"},
         "indexedAt": {"type": "string", "format": "datetime"},
-        "viewer": {"type": "ref", "ref": "#viewerState"},
-        "myState": {"type": "ref", "ref": "#myState", "description": "Deprecated"}
+        "viewer": {"type": "ref", "ref": "#viewerState"}
       }
     },
     "profileViewBasic": {
@@ -68,14 +67,6 @@
         "following": {"type": "string", "format": "at-uri"},
         "followedBy": {"type": "string", "format": "at-uri"}
       }
-    },
-    "myState": {
-      "type": "object",
-      "description": "Deprecated in favor of #viewerState",
-      "properties": {
-        "follow": {"type": "string", "format": "at-uri"},
-        "muted": {"type": "boolean"}
-      }
     }
   }
 }
diff --git a/lexicons/app/bsky/feed/defs.json b/lexicons/app/bsky/feed/defs.json
@@ -4,7 +4,7 @@
   "defs": {
     "postView": {
       "type": "object",
-      "required": ["uri", "cid", "author", "record", "replyCount", "repostCount", "likeCount", "indexedAt", "viewer"],
+      "required": ["uri", "cid", "author", "record", "indexedAt"],
       "properties": {
         "uri": {"type": "string"},
         "cid": {"type": "string"},
@@ -78,4 +78,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -2381,14 +2381,7 @@ export const schemaDict = {
       },
       profileView: {
         type: 'object',
-        required: [
-          'did',
-          'handle',
-          'creator',
-          'followersCount',
-          'followsCount',
-          'postsCount',
-        ],
+        required: ['did', 'handle', 'creator'],
         properties: {
           did: {
             type: 'string',
@@ -2431,11 +2424,6 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#viewerState',
           },
-          myState: {
-            type: 'ref',
-            ref: 'lex:app.bsky.actor.defs#myState',
-            description: 'Deprecated',
-          },
         },
       },
       profileViewBasic: {
@@ -2486,19 +2474,6 @@ export const schemaDict = {
           },
         },
       },
-      myState: {
-        type: 'object',
-        description: 'Deprecated in favor of #viewerState',
-        properties: {
-          follow: {
-            type: 'string',
-            format: 'at-uri',
-          },
-          muted: {
-            type: 'boolean',
-          },
-        },
-      },
     },
   },
   AppBskyActorGetProfile: {
@@ -3011,17 +2986,7 @@ export const schemaDict = {
     defs: {
       postView: {
         type: 'object',
-        required: [
-          'uri',
-          'cid',
-          'author',
-          'record',
-          'replyCount',
-          'repostCount',
-          'likeCount',
-          'indexedAt',
-          'viewer',
-        ],
+        required: ['uri', 'cid', 'author', 'record', 'indexedAt'],
         properties: {
           uri: {
             type: 'string',

diff --git a/packages/api/src/client/types/app/bsky/actor/defs.ts b/packages/api/src/client/types/app/bsky/actor/defs.ts
@@ -33,13 +33,12 @@ export interface ProfileView {
   description?: string
   avatar?: string
   banner?: string
-  followersCount: number
-  followsCount: number
-  postsCount: number
+  followersCount?: number
+  followsCount?: number
+  postsCount?: number
   creator: string
   indexedAt?: string
   viewer?: ViewerState
-  myState?: MyState
   [k: string]: unknown
 }
 
@@ -96,20 +95,3 @@ export function isViewerState(v: unknown): v is ViewerState {
 export function validateViewerState(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#viewerState', v)
 }
-
-/** Deprecated in favor of #viewerState */
-export interface MyState {
-  follow?: string
-  muted?: boolean
-  [k: string]: unknown
-}
-
-export function isMyState(v: unknown): v is MyState {
-  return (
-    isObj(v) && hasProp(v, '$type') && v.$type === 'app.bsky.actor.defs#myState'
-  )
-}
-
-export function validateMyState(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.actor.defs#myState', v)
-}
diff --git a/packages/api/src/client/types/app/bsky/feed/defs.ts b/packages/api/src/client/types/app/bsky/feed/defs.ts
@@ -19,11 +19,11 @@ export interface PostView {
     | AppBskyEmbedExternal.Presented
     | AppBskyEmbedRecord.Presented
     | { $type: string; [k: string]: unknown }
-  replyCount: number
-  repostCount: number
-  likeCount: number
+  replyCount?: number
+  repostCount?: number
+  likeCount?: number
   indexedAt: string
-  viewer: ViewerState
+  viewer?: ViewerState
   [k: string]: unknown
 }
 

diff --git a/packages/pds/src/app-view/services/actor/views.ts b/packages/pds/src/app-view/services/actor/views.ts
@@ -104,10 +104,6 @@ export class ActorViews {
           following: profileInfo?.requesterFollowing || undefined,
           followedBy: profileInfo?.requesterFollowedBy || undefined,
         },
-        myState: {
-          follow: profileInfo?.requesterFollowing || undefined,
-          muted: !!profileInfo?.requesterMuted,
-        },
       }
     })
 

diff --git a/packages/pds/src/lexicon/lexicons.ts b/packages/pds/src/lexicon/lexicons.ts
@@ -2381,14 +2381,7 @@ export const schemaDict = {
       },
       profileView: {
         type: 'object',
-        required: [
-          'did',
-          'handle',
-          'creator',
-          'followersCount',
-          'followsCount',
-          'postsCount',
-        ],
+        required: ['did', 'handle', 'creator'],
         properties: {
           did: {
             type: 'string',
@@ -2431,11 +2424,6 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.actor.defs#viewerState',
           },
-          myState: {
-            type: 'ref',
-            ref: 'lex:app.bsky.actor.defs#myState',
-            description: 'Deprecated',
-          },
         },
       },
       profileViewBasic: {
@@ -2486,19 +2474,6 @@ export const schemaDict = {
           },
         },
       },
-      myState: {
-        type: 'object',
-        description: 'Deprecated in favor of #viewerState',
-        properties: {
-          follow: {
-            type: 'string',
-            format: 'at-uri',
-          },
-          muted: {
-            type: 'boolean',
-          },
-        },
-      },
     },
   },
   AppBskyActorGetProfile: {
@@ -3011,17 +2986,7 @@ export const schemaDict = {
     defs: {
       postView: {
         type: 'object',
-        required: [
-          'uri',
-          'cid',
-          'author',
-          'record',
-          'replyCount',
-          'repostCount',
-          'likeCount',
-          'indexedAt',
-          'viewer',
-        ],
+        required: ['uri', 'cid', 'author', 'record', 'indexedAt'],
         properties: {
           uri: {
             type: 'string',

diff --git a/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts b/packages/pds/src/lexicon/types/app/bsky/actor/defs.ts
@@ -33,13 +33,12 @@ export interface ProfileView {
   description?: string
   avatar?: string
   banner?: string
-  followersCount: number
-  followsCount: number
-  postsCount: number
+  followersCount?: number
+  followsCount?: number
+  postsCount?: number
   creator: string
   indexedAt?: string
   viewer?: ViewerState
-  myState?: MyState
   [k: string]: unknown
 }
 
@@ -96,20 +95,3 @@ export function isViewerState(v: unknown): v is ViewerState {
 export function validateViewerState(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#viewerState', v)
 }
-
-/** Deprecated in favor of #viewerState */
-export interface MyState {
-  follow?: string
-  muted?: boolean
-  [k: string]: unknown
-}
-
-export function isMyState(v: unknown): v is MyState {
-  return (
-    isObj(v) && hasProp(v, '$type') && v.$type === 'app.bsky.actor.defs#myState'
-  )
-}
-
-export function validateMyState(v: unknown): ValidationResult {
-  return lexicons.validate('app.bsky.actor.defs#myState', v)
-}
diff --git a/packages/pds/src/lexicon/types/app/bsky/feed/defs.ts b/packages/pds/src/lexicon/types/app/bsky/feed/defs.ts
@@ -19,11 +19,11 @@ export interface PostView {
     | AppBskyEmbedExternal.Presented
     | AppBskyEmbedRecord.Presented
     | { $type: string; [k: string]: unknown }
-  replyCount: number
-  repostCount: number
-  likeCount: number
+  replyCount?: number
+  repostCount?: number
+  likeCount?: number
   indexedAt: string
-  viewer: ViewerState
+  viewer?: ViewerState
   [k: string]: unknown
 }
 

diff --git a/packages/pds/tests/__snapshots__/indexing.test.ts.snap b/packages/pds/tests/__snapshots__/indexing.test.ts.snap
@@ -125,9 +125,6 @@ Object {
   "followsCount": 0,
   "handle": "dan.test",
   "indexedAt": "1970-01-01T00:00:00.000Z",
-  "myState": Object {
-    "muted": false,
-  },
   "postsCount": 0,
   "viewer": Object {
     "muted": false,
@@ -144,9 +141,6 @@ Object {
   "followsCount": 0,
   "handle": "dan.test",
   "indexedAt": "1970-01-01T00:00:00.000Z",
-  "myState": Object {
-    "muted": false,
-  },
   "postsCount": 0,
   "viewer": Object {
     "muted": false,
@@ -161,9 +155,6 @@ Object {
   "followersCount": 0,
   "followsCount": 0,
   "handle": "dan.test",
-  "myState": Object {
-    "muted": false,
-  },
   "postsCount": 0,
   "viewer": Object {
     "muted": false,

diff --git a/packages/pds/tests/views/__snapshots__/author-feed.test.ts.snap b/packages/pds/tests/views/__snapshots__/author-feed.test.ts.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`pds author feed views fetches full author feeds for self (sorted, minimal myState). 1`] = `
+exports[`pds author feed views fetches full author feeds for self (sorted, minimal viewer state). 1`] = `
 Array [
   Object {
     "post": Object {
@@ -237,7 +237,7 @@ Array [
 ]
 `;
 
-exports[`pds author feed views fetches full author feeds for self (sorted, minimal myState). 2`] = `
+exports[`pds author feed views fetches full author feeds for self (sorted, minimal viewer state). 2`] = `
 Array [
   Object {
     "post": Object {
@@ -405,7 +405,7 @@ Array [
 ]
 `;
 
-exports[`pds author feed views fetches full author feeds for self (sorted, minimal myState). 3`] = `
+exports[`pds author feed views fetches full author feeds for self (sorted, minimal viewer state). 3`] = `
 Array [
   Object {
     "post": Object {
@@ -604,7 +604,7 @@ Array [
 ]
 `;
 
-exports[`pds author feed views fetches full author feeds for self (sorted, minimal myState). 4`] = `
+exports[`pds author feed views fetches full author feeds for self (sorted, minimal viewer state). 4`] = `
 Array [
   Object {
     "post": Object {