Simplify and refactor. New Agent. ESM-only build. (#5)

- replace BskyTldr class with utility functions that can be used directly.
- move to Agent and Session (remove deprecated AtpAgent).
- simplify build with ESM-only. Remove CJS.

Author: briangershon

README.md

@@ -4,6 +4,8 @@ Bluesky feed overload? Too long, didn't read?
 
 Skim a daily list of posts from people you follow, or use AI/LLMs to summarize them into text you can scan or feed to an agent.
 
+[Run example](#run-example) section below for a demo of integration with this library.
+
 ## Installation in your application
 
 ```bash
@@ -15,9 +17,16 @@ npm install bsky-tldr
 
 Exports from the library:
 
-`BskyTldr` is a class that contains lower level functions to retrieve Posts and Follows.
-`getDailyPostsFromFollows` is a higher level function to retrieve daily posts from follows. See Data Structure Example below.
-`uriToUrl` is a utility function to convert a post uri to a public url to view post on the web.
+`getDailyPostsFromFollows` is the main function to retrieve daily posts from follows. See Data Structure Example below.
+
+There are also utility functions that wrap the AtProto pagination with JavaScript generators:
+
+- `retrieveAuthorFeedGenerator()` is a generator function to retrieve posts from an author and
+- `retrieveFollowsGenerator` is a generator function to retrieve follows from an author.
+
+And if you want to convert post `uri` to a public URL:
+
+- `uriToUrl` is a utility function to convert a post uri to a public url to view post on the web.
 
 ## Data Structure Example
 
@@ -47,8 +56,6 @@ Here's the data structure built with our `getDailyPostsFromFollows` library func
 }
 ```
 
-You can use `uriToUrl()` function to convert the `uri` to a public URL to view the post on the web.
-
 The author's `did` and `handle` are provided, along with posts that include `uri`, `content`, `createdAt`, and `isRepost`.
 
 If you need more information in your app, use `@atproto/api` library directly to retrieve the author's profile using their `did`, or the full post and replies via its `uri`.

package-lock.json

@@ -19,15 +19,12 @@
     "/dist"
   ],
   "type": "module",
-  "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "default": "./dist/index.js"
+      "import": "./dist/index.js"
     }
   },
   "scripts": {

package.json

@@ -1,8 +1,8 @@
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
 import resolve from '@rollup/plugin-node-resolve';
 import terser from '@rollup/plugin-terser';
 import typescript from '@rollup/plugin-typescript';
-import commonjs from '@rollup/plugin-commonjs';
-import json from '@rollup/plugin-json';
 import dts from 'rollup-plugin-dts';
 
 const external = [
@@ -26,13 +26,11 @@ const plugins = [
     tsconfig: './tsconfig.json',
     sourceMap: true,
     declaration: false,
-    moduleResolution: 'node',
   }),
   terser(),
 ];
 
 export default [
-  // ESM build
   {
     input: 'src/index.ts',
     output: {
@@ -44,18 +42,6 @@ export default [
     plugins,
     external,
   },
-  // CJS build
-  {
-    input: 'src/index.ts',
-    output: {
-      file: 'dist/index.cjs',
-      format: 'cjs',
-      sourcemap: true,
-      exports: 'named',
-    },
-    plugins,
-    external,
-  },
   // Single d.ts file
   {
     input: 'src/index.ts',

rollup.config.mjs

@@ -7,18 +7,26 @@ import type {
 } from './lib/getDailyPostsFromFollows';
 
 // Import functions and classes
-import { BskyTldr } from './lib/bsky-tldr';
+import {
+  retrieveAuthorFeedGenerator,
+  retrieveFollowsGenerator,
+} from './lib/bsky-tldr';
 import { getDailyPostsFromFollows } from './lib/getDailyPostsFromFollows';
 import { uriToUrl } from './lib/uriToUrl';
 
 // Types
 export type {
-  Follow,
-  Post,
   AuthorFeed,
   DailyPostsFromFollows,
   DailyPostsFromFollowsResponse,
+  Follow,
+  Post,
 };
 
 // Core functionality
-export { BskyTldr, getDailyPostsFromFollows, uriToUrl };
+export {
+  getDailyPostsFromFollows,
+  retrieveAuthorFeedGenerator,
+  retrieveFollowsGenerator,
+  uriToUrl,
+};

src/index.ts

@@ -1,4 +1,4 @@
-import { AtpAgent } from '@atproto/api';
+import { Agent } from '@atproto/api';
 import {
   isReasonRepost,
   validateFeedViewPost,
@@ -16,102 +16,98 @@ export interface Post {
   isRepost: boolean;
 }
 
-export class BskyTldr {
-  private bluesky: AtpAgent;
-
-  constructor(agent: AtpAgent) {
-    this.bluesky = agent;
+export async function* retrieveFollowsGenerator({
+  bluesky,
+  actor,
+  batchSize = 50,
+}: {
+  bluesky: Agent;
+  actor: string;
+  batchSize?: number;
+}): AsyncGenerator<Follow, void, undefined> {
+  if (!bluesky) {
+    throw new Error('Bluesky client not initialized');
   }
 
-  async *retrieveFollowsGenerator({
-    actor,
-    batchSize = 50,
-  }: {
-    actor: string;
-    batchSize?: number;
-  }): AsyncGenerator<Follow, void, undefined> {
-    if (!this.bluesky) {
-      throw new Error('Bluesky client not initialized');
-    }
-
-    let cursor: string | undefined = undefined;
-
-    try {
-      do {
-        const response = await this.bluesky.getFollows({
-          actor,
-          limit: batchSize,
-          cursor,
-        });
-
-        if (!response.success) {
-          throw new Error('Failed to fetch follows');
-        }
-
-        for (const follow of response.data.follows) {
-          yield {
-            did: follow.did,
-            handle: follow.handle,
-          };
-        }
-
-        cursor = response.data.cursor;
-      } while (cursor);
-    } catch (error) {
-      throw new Error(
-        `Failed to retrieve follows: ${
-          error instanceof Error ? error.message : 'Unknown error'
-        }`
-      );
-    }
+  let cursor: string | undefined = undefined;
+
+  try {
+    do {
+      const response = await bluesky.getFollows({
+        actor,
+        limit: batchSize,
+        cursor,
+      });
+
+      if (!response.success) {
+        throw new Error('Failed to fetch follows');
+      }
+
+      for (const follow of response.data.follows) {
+        yield {
+          did: follow.did,
+          handle: follow.handle,
+        };
+      }
+
+      cursor = response.data.cursor;
+    } while (cursor);
+  } catch (error) {
+    throw new Error(
+      `Failed to retrieve follows: ${
+        error instanceof Error ? error.message : 'Unknown error'
+      }`
+    );
   }
+}
 
-  async *retrieveAuthorFeedGenerator({
-    actor,
-    batchSize = 5,
-  }: {
-    actor: string;
-    batchSize?: number;
-  }): AsyncGenerator<Post, void, undefined> {
-    if (!this.bluesky) {
-      throw new Error('Bluesky client not initialized');
-    }
-
-    let cursor: string | undefined = undefined;
-    let count = 0;
-
-    try {
-      do {
-        const { data } = await this.bluesky.getAuthorFeed({
-          actor,
-          limit: batchSize,
-          cursor,
-        });
-
-        for (const feedViewPost of data.feed) {
-          if (!validateFeedViewPost(feedViewPost)) {
-            console.info('Invalid feed view post:', feedViewPost);
-            continue;
-          }
+export async function* retrieveAuthorFeedGenerator({
+  bluesky,
+  actor,
+  batchSize = 5,
+}: {
+  bluesky: Agent;
+  actor: string;
+  batchSize?: number;
+}): AsyncGenerator<Post, void, undefined> {
+  if (!bluesky) {
+    throw new Error('Bluesky client not initialized');
+  }
 
-          const postView = feedViewPost.post;
-          yield {
-            uri: postView.uri,
-            content: (postView.record.text as string) || '',
-            createdAt: (postView.record.createdAt as string) || '',
-            isRepost: isReasonRepost(feedViewPost.reason),
-          };
-          count++;
+  let cursor: string | undefined = undefined;
+  let count = 0;
+
+  try {
+    do {
+      const { data } = await bluesky.getAuthorFeed({
+        actor,
+        limit: batchSize,
+        cursor,
+      });
+
+      for (const feedViewPost of data.feed) {
+        if (!validateFeedViewPost(feedViewPost)) {
+          console.info('Invalid feed view post:', feedViewPost);
+          continue;
         }
 
-        cursor = data.cursor;
-      } while (cursor);
-    } catch (error) {
-      throw new Error(
-        `Failed to retrieve author feed: ${
-          error instanceof Error ? error.message : 'Unknown error'
-        }`
-      );
-    }
+        const postView = feedViewPost.post;
+        yield {
+          uri: postView.uri,
+          content: (postView.record.text as string) || '',
+          createdAt: (postView.record.createdAt as string) || '',
+          isRepost: isReasonRepost(feedViewPost.reason),
+        };
+        count++;
+      }
+
+      cursor = data.cursor;
+    } while (cursor);
+  } catch (error) {
+    throw new Error(
+      `Failed to retrieve author feed: ${
+        error instanceof Error ? error.message : 'Unknown error'
+      }`
+    );
   }
 }