Added comments and reactions to fetchPost

Author: KirillSergeevich

examples/fetch-post.ts

@@ -1,4 +1,4 @@
-import LinkedApi, { LinkedApiError } from 'linkedapi-node';
+import LinkedApi, { LinkedApiError, POST_COMMENTS_SORT } from 'linkedapi-node';
 
 async function fetchPostExample(): Promise<void> {
   const linkedapi = new LinkedApi({
@@ -21,7 +21,16 @@ async function fetchPostExample(): Promise<void> {
 
 async function standardExample(linkedapi: LinkedApi): Promise<void> {
   const workflowId = await linkedapi.fetchPost.execute({
-    postUrl: 'https://www.linkedin.com/posts/post-url'
+    postUrl: 'https://www.linkedin.com/posts/post-url',
+    retrieveComments: true,
+    retrieveReactions: true,
+    commentsRetrievalConfig: {
+      limit: 25,
+      sort: POST_COMMENTS_SORT.mostRelevant,
+    },
+    reactionsRetrievalConfig: {
+      limit: 100,
+    },
   });
   console.log('🔍 Workflow started:', workflowId);
   const postResult = await linkedapi.fetchPost.result(workflowId);
@@ -39,6 +48,8 @@ async function standardExample(linkedapi: LinkedApi): Promise<void> {
     console.log(`👍 Reactions: ${post.reactionsCount}`);
     console.log(`💬 Comments: ${post.commentsCount}`);
     console.log(`🔄 Reposts: ${post.repostsCount}`);
+    console.log(`👍 Reactions: ${post.reactions?.length || 0}`);
+    console.log(`💬 Comments: ${post.comments?.length || 0}`);
   }
   if (postResult.errors.length > 0) {
     console.error('🚨 Errors:', JSON.stringify(postResult.errors, null, 2));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "linkedapi-node",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "Official TypeScript SDK for Linked API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/operations/fetch-post.ts

@@ -1,15 +1,54 @@
 import { Operation, TOperationName } from '../core';
-import { SimpleWorkflowMapper } from '../mappers';
-import { TFetchPostParams, TFetchPostResult } from '../types';
+import { TActionConfig, ThenWorkflowMapper } from '../mappers';
+import { TBaseFetchPostParams, TFetchPostParams, TFetchPostResult } from '../types';
 
-export class FetchPost extends Operation<TFetchPostParams, TFetchPostResult> {
+export class FetchPost extends Operation<TBaseFetchPostParams, TFetchPostResult> {
   public override readonly operationName: TOperationName = 'fetchPost';
-  protected override readonly mapper = new SimpleWorkflowMapper<TFetchPostParams, TFetchPostResult>(
-    {
-      actionType: 'st.openPost',
+  protected override readonly mapper = new FetchPostMapper();
+
+  public override async execute<TParams extends TBaseFetchPostParams>(
+    params: TFetchPostParams<TParams>,
+  ): Promise<string> {
+    return super.execute(params);
+  }
+}
+
+const FETCH_POST_ACTIONS: TActionConfig[] = [
+  {
+    paramName: 'retrieveComments',
+    actionType: 'st.retrievePostComments',
+    configSource: 'commentsRetrievalConfig',
+  },
+  {
+    paramName: 'retrieveReactions',
+    actionType: 'st.retrievePostReactions',
+    configSource: 'reactionsRetrievalConfig',
+  },
+];
+
+const RESPONSE_MAPPINGS = [
+  {
+    actionType: 'st.retrievePostComments',
+    targetProperty: 'comments',
+  },
+  {
+    actionType: 'st.retrievePostReactions',
+    targetProperty: 'reactions',
+  },
+];
+
+export class FetchPostMapper<TParams extends TBaseFetchPostParams> extends ThenWorkflowMapper<
+  TParams,
+  TFetchPostResult
+> {
+  constructor() {
+    super({
+      actionConfigs: FETCH_POST_ACTIONS,
+      responseMappings: RESPONSE_MAPPINGS,
+      baseActionType: 'st.openPost',
       defaultParams: {
         basicInfo: true,
       },
-    },
-  );
+    });
+  }
 }

src/types/actions/post.ts

@@ -1,4 +1,4 @@
-import { TBaseActionParams } from '../params';
+import { TBaseActionParams, TLimitParams } from '../params';
 
 export interface TPost {
   url: string;
@@ -12,6 +12,8 @@ export interface TPost {
   reactionsCount: number;
   commentsCount: number;
   repostsCount: number;
+  comments?: ReadonlyArray<TPostComment>;
+  reactions?: ReadonlyArray<TPostReaction>;
 }
 
 export const POST_TYPE = {
@@ -20,12 +22,6 @@ export const POST_TYPE = {
 } as const;
 export type TPostType = (typeof POST_TYPE)[keyof typeof POST_TYPE];
 
-export interface TFetchPostParams extends TBaseActionParams {
-  postUrl: string;
-}
-
-export type TFetchPostResult = TPost;
-
 export interface TReaction {
   postUrl: string;
   time: string;
@@ -59,3 +55,71 @@ export interface TCommentOnPostParams extends TBaseActionParams {
   postUrl: string;
   text: string;
 }
+
+export const POST_COMMENTER_TYPE = {
+  person: 'person',
+  company: 'company',
+} as const;
+export type TPostCommenterType = (typeof POST_COMMENTER_TYPE)[keyof typeof POST_COMMENTER_TYPE];
+
+export interface TPostComment {
+  commenterUrl: string;
+  commenterName: string;
+  commenterHeadline: string;
+  commenterType: TPostCommenterType;
+  time: string;
+  text: string | null;
+  image: string | null;
+  isReply: boolean;
+  reactionsCount: number;
+  repliesCount: number;
+}
+
+export const POST_ENGAGER_TYPE = {
+  person: 'person',
+  company: 'company',
+} as const;
+export type TPostEngagerType = (typeof POST_ENGAGER_TYPE)[keyof typeof POST_ENGAGER_TYPE];
+
+export interface TPostReaction {
+  engagerUrl: string;
+  engagerName: string;
+  engagerHeadline: string;
+  engagerType: TPostEngagerType;
+  type: TReactionType;
+}
+
+export const POST_COMMENTS_SORT = {
+  mostRelevant: 'mostRelevant',
+  mostRecent: 'mostRecent',
+} as const;
+export type TPostCommentsSort = (typeof POST_COMMENTS_SORT)[keyof typeof POST_COMMENTS_SORT];
+
+export interface TPostCommentsRetrievalConfig extends TLimitParams {
+  replies?: boolean;
+  sort?: TPostCommentsSort;
+}
+
+export type TPostReactionsRetrievalConfig = TLimitParams;
+
+export interface TBaseFetchPostParams extends TBaseActionParams {
+  postUrl: string;
+  retrieveComments?: boolean;
+  retrieveReactions?: boolean;
+}
+
+export interface TBaseFetchPostParamsWide extends TBaseFetchPostParams {
+  retrieveComments: true;
+  retrieveReactions: true;
+}
+
+export type TFetchPostParams<T extends TBaseFetchPostParams = TBaseFetchPostParams> = T & {
+  commentsRetrievalConfig?: T['retrieveComments'] extends true
+    ? TPostCommentsRetrievalConfig | undefined
+    : never;
+  reactionsRetrievalConfig?: T['retrieveReactions'] extends true
+    ? TPostReactionsRetrievalConfig | undefined
+    : never;
+};
+
+export type TFetchPostResult = TPost;