ref docs for feed module

examples/node/scripts/feed/fetch.ts

@@ -0,0 +1,29 @@
+import {
+  getAuthenticatedClientFromEthersWallet,
+  getOwnedProfileId,
+} from '../shared/getAuthenticatedClient';
+import { setupWallet } from '../shared/setupWallet';
+
+async function main() {
+  const wallet = setupWallet();
+  const client = await getAuthenticatedClientFromEthersWallet(wallet);
+  const profileId = await getOwnedProfileId(client, wallet.address);
+
+  const result = await client.feed.fetch({
+    where: {
+      for: profileId,
+    },
+  });
+
+  const value = result.unwrap();
+
+  console.log(
+    `Feed for ${profileId}`,
+    value.items.map((item) => ({
+      id: item.root.id,
+      metadata: item.root.metadata,
+    })),
+  );
+}
+
+main();

examples/node/scripts/feed/highlights.ts

@@ -0,0 +1,29 @@
+import {
+  getAuthenticatedClientFromEthersWallet,
+  getOwnedProfileId,
+} from '../shared/getAuthenticatedClient';
+import { setupWallet } from '../shared/setupWallet';
+
+async function main() {
+  const wallet = setupWallet();
+  const client = await getAuthenticatedClientFromEthersWallet(wallet);
+  const profileId = await getOwnedProfileId(client, wallet.address);
+
+  const result = await client.feed.highlights({
+    where: {
+      for: profileId,
+    },
+  });
+
+  const value = result.unwrap();
+
+  console.log(
+    `Feed highlights for ${profileId}`,
+    value.items.map((item) => ({
+      id: item.id,
+      metadata: item.metadata,
+    })),
+  );
+}
+
+main();

packages/client/src/index.ts

@@ -92,6 +92,8 @@ export type {
   LensTransactionStatusRequest,
   ExploreProfilesRequest,
   ExplorePublicationRequest,
+  FeedHighlightsRequest,
+  FeedRequest,
 
   // options
   TypedDataOptions,

packages/client/src/submodules/feed/Feed.ts

@@ -34,6 +34,23 @@ export class Feed {
     this.authentication = authentication;
   }
 
+  /**
+   * Fetch feed items.
+   *
+   * ⚠️ Requires authenticated LensClient.
+   *
+   * @param request - Request object for the query
+   * @returns Array of {@link FeedItemFragment} wrapped in {@link PaginatedResult}
+   *
+   * @example
+   * ```ts
+   * const result = await client.feed.fetch({
+   *   where: {
+   *     for: '0x123',
+   *   },
+   * });
+   * ```
+   */
   async fetch(
     request: FeedRequest,
   ): PromiseResult<
@@ -55,6 +72,23 @@ export class Feed {
     });
   }
 
+  /**
+   * Fetch feed highlights.
+   *
+   * ⚠️ Requires authenticated LensClient.
+   *
+   * @param request - Request object for the query
+   * @returns Array of publications wrapped in {@link PaginatedResult}
+   *
+   * @example
+   * ```ts
+   * const result = await client.feed.highlights({
+   *   where: {
+   *     for: '0x123',
+   *   },
+   * });
+   * ```
+   */
   async highlights(
     request: FeedHighlightsRequest,
   ): PromiseResult<

packages/client/src/submodules/feed/index.ts

@@ -1,3 +1,3 @@
-export type { FeedItemFragment, ReactionEventFragment } from './graphql/feed.generated';
-
 export * from './Feed';
+
+export type { FeedItemFragment, ReactionEventFragment } from './graphql/feed.generated';