feed generator content mode (#3389)

bluesky-social · Jan 17, 2025 · cbf1706 · cbf1706
1 parent 9c01281
commit cbf1706
Show file tree

Hide file tree

Showing 22 changed files with 320 additions and 16 deletions.
diff --git a/.changeset/dull-zebras-prove.md b/.changeset/dull-zebras-prove.md
@@ -0,0 +1,6 @@
+---
+"@atproto/bsky": patch
+"@atproto/api": patch
+---
+
+add feedgen content mode lexicon spec
diff --git a/lexicons/app/bsky/feed/defs.json b/lexicons/app/bsky/feed/defs.json
@@ -162,6 +162,13 @@
           "items": { "type": "ref", "ref": "com.atproto.label.defs#label" }
         },
         "viewer": { "type": "ref", "ref": "#generatorViewerState" },
+        "contentMode": {
+          "type": "string",
+          "knownValues": [
+            "app.bsky.feed.defs#contentModeUnspecified",
+            "app.bsky.feed.defs#contentModeVideo"
+          ]
+        },
         "indexedAt": { "type": "string", "format": "datetime" }
       }
     },
@@ -262,6 +269,14 @@
       "type": "token",
       "description": "User clicked through to the embedded content of the feed item"
     },
+    "contentModeUnspecified": {
+      "type": "token",
+      "description": "Declares the feed generator returns any types of posts."
+    },
+    "contentModeVideo": {
+      "type": "token",
+      "description": "Declares the feed generator returns posts containing app.bsky.embed.video embeds."
+    },
     "interactionSeen": {
       "type": "token",
       "description": "Feed item was seen by user"

diff --git a/lexicons/app/bsky/feed/generator.json b/lexicons/app/bsky/feed/generator.json
@@ -39,6 +39,13 @@
             "description": "Self-label values",
             "refs": ["com.atproto.label.defs#selfLabels"]
           },
+          "contentMode": {
+            "type": "string",
+            "knownValues": [
+              "app.bsky.feed.defs#contentModeUnspecified",
+              "app.bsky.feed.defs#contentModeVideo"
+            ]
+          },
           "createdAt": { "type": "string", "format": "datetime" }
         }
       }

diff --git a/packages/api/src/client/index.ts b/packages/api/src/client/index.ts
@@ -478,6 +478,8 @@ export const APP_BSKY_FEED = {
   DefsClickthroughAuthor: 'app.bsky.feed.defs#clickthroughAuthor',
   DefsClickthroughReposter: 'app.bsky.feed.defs#clickthroughReposter',
   DefsClickthroughEmbed: 'app.bsky.feed.defs#clickthroughEmbed',
+  DefsContentModeUnspecified: 'app.bsky.feed.defs#contentModeUnspecified',
+  DefsContentModeVideo: 'app.bsky.feed.defs#contentModeVideo',
   DefsInteractionSeen: 'app.bsky.feed.defs#interactionSeen',
   DefsInteractionLike: 'app.bsky.feed.defs#interactionLike',
   DefsInteractionRepost: 'app.bsky.feed.defs#interactionRepost',

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -5778,6 +5778,13 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.feed.defs#generatorViewerState',
           },
+          contentMode: {
+            type: 'string',
+            knownValues: [
+              'app.bsky.feed.defs#contentModeUnspecified',
+              'app.bsky.feed.defs#contentModeVideo',
+            ],
+          },
           indexedAt: {
             type: 'string',
             format: 'datetime',
@@ -5912,6 +5919,15 @@ export const schemaDict = {
         description:
           'User clicked through to the embedded content of the feed item',
       },
+      contentModeUnspecified: {
+        type: 'token',
+        description: 'Declares the feed generator returns any types of posts.',
+      },
+      contentModeVideo: {
+        type: 'token',
+        description:
+          'Declares the feed generator returns posts containing app.bsky.embed.video embeds.',
+      },
       interactionSeen: {
         type: 'token',
         description: 'Feed item was seen by user',
@@ -6043,6 +6059,13 @@ export const schemaDict = {
               description: 'Self-label values',
               refs: ['lex:com.atproto.label.defs#selfLabels'],
             },
+            contentMode: {
+              type: 'string',
+              knownValues: [
+                'app.bsky.feed.defs#contentModeUnspecified',
+                'app.bsky.feed.defs#contentModeVideo',
+              ],
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',

diff --git a/packages/api/src/client/types/app/bsky/feed/defs.ts b/packages/api/src/client/types/app/bsky/feed/defs.ts
@@ -247,6 +247,10 @@ export interface GeneratorView {
   acceptsInteractions?: boolean
   labels?: ComAtprotoLabelDefs.Label[]
   viewer?: GeneratorViewerState
+  contentMode?:
+    | 'app.bsky.feed.defs#contentModeUnspecified'
+    | 'app.bsky.feed.defs#contentModeVideo'
+    | (string & {})
   indexedAt: string
   [k: string]: unknown
 }
@@ -401,6 +405,11 @@ export const CLICKTHROUGHAUTHOR = 'app.bsky.feed.defs#clickthroughAuthor'
 export const CLICKTHROUGHREPOSTER = 'app.bsky.feed.defs#clickthroughReposter'
 /** User clicked through to the embedded content of the feed item */
 export const CLICKTHROUGHEMBED = 'app.bsky.feed.defs#clickthroughEmbed'
+/** Declares the feed generator returns any types of posts. */
+export const CONTENTMODEUNSPECIFIED =
+  'app.bsky.feed.defs#contentModeUnspecified'
+/** Declares the feed generator returns posts containing app.bsky.embed.video embeds. */
+export const CONTENTMODEVIDEO = 'app.bsky.feed.defs#contentModeVideo'
 /** Feed item was seen by user */
 export const INTERACTIONSEEN = 'app.bsky.feed.defs#interactionSeen'
 /** User liked the feed item */

diff --git a/packages/api/src/client/types/app/bsky/feed/generator.ts b/packages/api/src/client/types/app/bsky/feed/generator.ts
@@ -19,6 +19,10 @@ export interface Record {
   labels?:
     | ComAtprotoLabelDefs.SelfLabels
     | { $type: string; [k: string]: unknown }
+  contentMode?:
+    | 'app.bsky.feed.defs#contentModeUnspecified'
+    | 'app.bsky.feed.defs#contentModeVideo'
+    | (string & {})
   createdAt: string
   [k: string]: unknown
 }

diff --git a/packages/bsky/src/lexicon/index.ts b/packages/bsky/src/lexicon/index.ts
@@ -181,6 +181,8 @@ export const APP_BSKY_FEED = {
   DefsClickthroughAuthor: 'app.bsky.feed.defs#clickthroughAuthor',
   DefsClickthroughReposter: 'app.bsky.feed.defs#clickthroughReposter',
   DefsClickthroughEmbed: 'app.bsky.feed.defs#clickthroughEmbed',
+  DefsContentModeUnspecified: 'app.bsky.feed.defs#contentModeUnspecified',
+  DefsContentModeVideo: 'app.bsky.feed.defs#contentModeVideo',
   DefsInteractionSeen: 'app.bsky.feed.defs#interactionSeen',
   DefsInteractionLike: 'app.bsky.feed.defs#interactionLike',
   DefsInteractionRepost: 'app.bsky.feed.defs#interactionRepost',

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -5778,6 +5778,13 @@ export const schemaDict = {
             type: 'ref',
             ref: 'lex:app.bsky.feed.defs#generatorViewerState',
           },
+          contentMode: {
+            type: 'string',
+            knownValues: [
+              'app.bsky.feed.defs#contentModeUnspecified',
+              'app.bsky.feed.defs#contentModeVideo',
+            ],
+          },
           indexedAt: {
             type: 'string',
             format: 'datetime',
@@ -5912,6 +5919,15 @@ export const schemaDict = {
         description:
           'User clicked through to the embedded content of the feed item',
       },
+      contentModeUnspecified: {
+        type: 'token',
+        description: 'Declares the feed generator returns any types of posts.',
+      },
+      contentModeVideo: {
+        type: 'token',
+        description:
+          'Declares the feed generator returns posts containing app.bsky.embed.video embeds.',
+      },
       interactionSeen: {
         type: 'token',
         description: 'Feed item was seen by user',
@@ -6043,6 +6059,13 @@ export const schemaDict = {
               description: 'Self-label values',
               refs: ['lex:com.atproto.label.defs#selfLabels'],
             },
+            contentMode: {
+              type: 'string',
+              knownValues: [
+                'app.bsky.feed.defs#contentModeUnspecified',
+                'app.bsky.feed.defs#contentModeVideo',
+              ],
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',

diff --git a/packages/bsky/src/lexicon/types/app/bsky/feed/defs.ts b/packages/bsky/src/lexicon/types/app/bsky/feed/defs.ts
@@ -247,6 +247,10 @@ export interface GeneratorView {
   acceptsInteractions?: boolean
   labels?: ComAtprotoLabelDefs.Label[]
   viewer?: GeneratorViewerState
+  contentMode?:
+    | 'app.bsky.feed.defs#contentModeUnspecified'
+    | 'app.bsky.feed.defs#contentModeVideo'
+    | (string & {})
   indexedAt: string
   [k: string]: unknown
 }
@@ -401,6 +405,11 @@ export const CLICKTHROUGHAUTHOR = 'app.bsky.feed.defs#clickthroughAuthor'
 export const CLICKTHROUGHREPOSTER = 'app.bsky.feed.defs#clickthroughReposter'
 /** User clicked through to the embedded content of the feed item */
 export const CLICKTHROUGHEMBED = 'app.bsky.feed.defs#clickthroughEmbed'
+/** Declares the feed generator returns any types of posts. */
+export const CONTENTMODEUNSPECIFIED =
+  'app.bsky.feed.defs#contentModeUnspecified'
+/** Declares the feed generator returns posts containing app.bsky.embed.video embeds. */
+export const CONTENTMODEVIDEO = 'app.bsky.feed.defs#contentModeVideo'
 /** Feed item was seen by user */
 export const INTERACTIONSEEN = 'app.bsky.feed.defs#interactionSeen'
 /** User liked the feed item */

diff --git a/packages/bsky/src/lexicon/types/app/bsky/feed/generator.ts b/packages/bsky/src/lexicon/types/app/bsky/feed/generator.ts
@@ -19,6 +19,10 @@ export interface Record {
   labels?:
     | ComAtprotoLabelDefs.SelfLabels
     | { $type: string; [k: string]: unknown }
+  contentMode?:
+    | 'app.bsky.feed.defs#contentModeUnspecified'
+    | 'app.bsky.feed.defs#contentModeVideo'
+    | (string & {})
   createdAt: string
   [k: string]: unknown
 }

diff --git a/packages/bsky/src/views/index.ts b/packages/bsky/src/views/index.ts
@@ -572,6 +572,7 @@ export class Views {
             like: viewer.like,
           }
         : undefined,
+      contentMode: feedgen.record.contentMode,
       indexedAt: this.indexedAt(feedgen).toISOString(),
     }
   }