@atproto/bsky 0.0.237 → 0.0.239

package/tests/views/drafts.test.ts

@@ -8,6 +8,7 @@ import {
   vi,
 } from 'vitest'
 import {
+  $Typed,
   AppBskyDraftCreateDraft,
   AppBskyDraftDefs,
   AppBskyDraftGetDrafts,
@@ -302,6 +303,110 @@ describe('appview drafts views', () => {
       expect(paginated.at(-1)?.id).toBe(full.at(-1)?.id)
     })
   })
+
+  describe('gallery embed', () => {
+    const galleryItem = (
+      i: number,
+    ): $Typed<AppBskyDraftDefs.DraftEmbedImage> => ({
+      $type: 'app.bsky.draft.defs#draftEmbedImage',
+      localRef: { path: `/local/img-${i}.jpg` },
+      alt: `image ${i}`,
+    })
+
+    const galleryDraft = (size: number): AppBskyDraftDefs.Draft => ({
+      posts: [
+        {
+          text: 'gallery draft',
+          embedGallery: {
+            items: Array.from({ length: size }, (_, i) => galleryItem(i)),
+          },
+        },
+      ],
+    })
+
+    it('round-trips a draft with embedGallery', async () => {
+      await create(alice, galleryDraft(3))
+      const { data } = await get(alice)
+      expect(data.drafts).toHaveLength(1)
+
+      const post = data.drafts[0].draft.posts[0]
+      expect(post.embedGallery?.items).toHaveLength(3)
+      post.embedGallery?.items.forEach((item, i) => {
+        expect(item.$type).toBe('app.bsky.draft.defs#draftEmbedImage')
+        if (AppBskyDraftDefs.isDraftEmbedImage(item)) {
+          expect(item.localRef.path).toBe(`/local/img-${i}.jpg`)
+          expect(item.alt).toBe(`image ${i}`)
+        }
+      })
+    })
+
+    it('updates a draft to add a gallery', async () => {
+      await create(alice, { posts: [{ text: 'text only' }] })
+      const { data: before } = await get(alice)
+      expect(before.drafts).toHaveLength(1)
+      expect(before.drafts[0].draft.posts[0].embedGallery).toBeUndefined()
+
+      const draftId = before.drafts[0].id
+      await update(alice, {
+        id: draftId,
+        draft: galleryDraft(2),
+      })
+
+      const { data: after } = await get(alice)
+      expect(after.drafts).toHaveLength(1)
+      expect(after.drafts[0].id).toBe(draftId)
+      expect(after.drafts[0].draft.posts[0].embedGallery?.items).toHaveLength(2)
+    })
+
+    it('updates a draft to change gallery items', async () => {
+      await create(alice, galleryDraft(2))
+      const { data: before } = await get(alice)
+      expect(before.drafts[0].draft.posts[0].embedGallery?.items).toHaveLength(
+        2,
+      )
+
+      const draftId = before.drafts[0].id
+      await update(alice, {
+        id: draftId,
+        draft: galleryDraft(5),
+      })
+
+      const { data: after } = await get(alice)
+      const post = after.drafts[0].draft.posts[0]
+      expect(post.embedGallery?.items).toHaveLength(5)
+      // Confirm full replacement (new items 0..4, not appended onto old 0..1).
+      post.embedGallery?.items.forEach((item, i) => {
+        if (AppBskyDraftDefs.isDraftEmbedImage(item)) {
+          expect(item.localRef.path).toBe(`/local/img-${i}.jpg`)
+        }
+      })
+    })
+
+    it('rejects embedGallery.items exceeding maxLength=20', async () => {
+      await expect(create(alice, galleryDraft(21))).rejects.toThrow()
+    })
+
+    it('rejects gallery items without $type', async () => {
+      const badDraft = {
+        posts: [
+          {
+            text: 'gallery without $type',
+            embedGallery: {
+              items: [
+                // Union members must be $type-tagged. Cast away types so the
+                // request reaches the server, where lex validation rejects it.
+                {
+                  localRef: { path: '/local/untagged.jpg' },
+                  alt: 'untagged',
+                } as unknown as $Typed<AppBskyDraftDefs.DraftEmbedImage>,
+              ],
+            },
+          },
+        ],
+      }
+      await expect(create(alice, badDraft)).rejects.toThrow()
+    })
+  })
 })
 
 const clearDrafts = async (db: Database) => {

package/tests/views/posts.test.ts

@@ -1,5 +1,6 @@
 import { afterAll, beforeAll, describe, expect, it } from 'vitest'
 import {
+  AppBskyEmbedGallery,
   AppBskyEmbedRecord,
   AppBskyEmbedRecordWithMedia,
   AppBskyEmbedVideo,
@@ -291,4 +292,137 @@ describe('pds posts views', () => {
     expect(data.posts.length).toBe(1)
     expect(forSnapshot(data.posts[0])).toMatchSnapshot()
   })
+
+  it('embeds gallery.', async () => {
+    const img1 = await sc.uploadFile(
+      sc.dids.alice,
+      '../dev-env/assets/key-landscape-small.jpg',
+      'image/jpeg',
+    )
+    const img2 = await sc.uploadFile(
+      sc.dids.alice,
+      '../dev-env/assets/key-portrait-small.jpg',
+      'image/jpeg',
+    )
+    const { uri } = await pdsAgent.api.app.bsky.feed.post.create(
+      { repo: sc.dids.alice },
+      {
+        text: 'gallery',
+        createdAt: new Date().toISOString(),
+        embed: {
+          $type: 'app.bsky.embed.gallery',
+          items: [
+            {
+              $type: 'app.bsky.embed.gallery#image',
+              image: img1.image,
+              alt: 'landscape',
+              aspectRatio: { width: 4, height: 3 },
+            },
+            {
+              $type: 'app.bsky.embed.gallery#image',
+              image: img2.image,
+              alt: 'portrait',
+              aspectRatio: { width: 3, height: 4 },
+            },
+          ],
+        } satisfies AppBskyEmbedGallery.Main,
+      },
+      sc.getHeaders(sc.dids.alice),
+    )
+    await network.processAll()
+    const { data } = await agent.app.bsky.feed.getPosts({ uris: [uri] })
+    expect(data.posts.length).toBe(1)
+    expect(forSnapshot(data.posts[0])).toMatchSnapshot()
+  })
+
+  it('embeds gallery with record.', async () => {
+    const img = await sc.uploadFile(
+      sc.dids.alice,
+      '../dev-env/assets/key-landscape-small.jpg',
+      'image/jpeg',
+    )
+    const embedRecord = await pdsAgent.api.app.bsky.feed.post.create(
+      { repo: sc.dids.alice },
+      {
+        text: 'embedded',
+        createdAt: new Date().toISOString(),
+      },
+      sc.getHeaders(sc.dids.alice),
+    )
+    const { uri } = await pdsAgent.api.app.bsky.feed.post.create(
+      { repo: sc.dids.alice },
+      {
+        text: 'gallery + record',
+        createdAt: new Date().toISOString(),
+        embed: {
+          $type: 'app.bsky.embed.recordWithMedia',
+          record: {
+            record: {
+              uri: embedRecord.uri,
+              cid: embedRecord.cid,
+            },
+          } satisfies AppBskyEmbedRecord.Main,
+          media: {
+            $type: 'app.bsky.embed.gallery',
+            items: [
+              {
+                $type: 'app.bsky.embed.gallery#image',
+                image: img.image,
+                alt: 'landscape',
+                aspectRatio: { width: 4, height: 3 },
+              },
+            ],
+          } satisfies AppBskyEmbedGallery.Main,
+        } satisfies AppBskyEmbedRecordWithMedia.Main,
+      },
+      sc.getHeaders(sc.dids.alice),
+    )
+    await network.processAll()
+    const { data } = await agent.app.bsky.feed.getPosts({ uris: [uri] })
+    expect(data.posts.length).toBe(1)
+    expect(forSnapshot(data.posts[0])).toMatchSnapshot()
+  })
+
+  it('truncates gallery view to soft limit of 10 items.', async () => {
+    const img = await sc.uploadFile(
+      sc.dids.alice,
+      '../dev-env/assets/key-landscape-small.jpg',
+      'image/jpeg',
+    )
+    const items: AppBskyEmbedGallery.Main['items'] = Array.from(
+      { length: 11 },
+      (_, i) => ({
+        $type: 'app.bsky.embed.gallery#image',
+        image: img.image,
+        alt: `item ${i}`,
+        aspectRatio: { width: 4, height: 3 },
+      }),
+    )
+    const { uri } = await pdsAgent.api.app.bsky.feed.post.create(
+      { repo: sc.dids.alice },
+      {
+        text: 'oversize gallery',
+        createdAt: new Date().toISOString(),
+        embed: {
+          $type: 'app.bsky.embed.gallery',
+          items,
+        } satisfies AppBskyEmbedGallery.Main,
+      },
+      sc.getHeaders(sc.dids.alice),
+    )
+    await network.processAll()
+    const { data } = await agent.app.bsky.feed.getPosts({ uris: [uri] })
+    expect(data.posts.length).toBe(1)
+    const embed = data.posts[0].embed
+    if (!embed || !AppBskyEmbedGallery.isView(embed)) {
+      throw new Error('expected gallery view')
+    }
+    expect(embed.items).toHaveLength(10)
+    // Verify the AppView keeps the head of the items list (not the tail).
+    embed.items.forEach((item, i) => {
+      if (AppBskyEmbedGallery.isViewImage(item)) {
+        expect(item.alt).toBe(`item ${i}`)
+      }
+    })
+  })
 })

package/tsconfig.build.json

@@ -3,8 +3,8 @@
   "compilerOptions": {
     "rootDir": "./src",
     "outDir": "./dist",
-    "noUnusedLocals": false
+    "noUnusedLocals": false,
   },
   "include": ["./src"],
-  "exclude": ["./src/**/*.test.ts"]
+  "exclude": ["./src/**/*.test.ts"],
 }