@ph-cms/client-sdk 0.1.45 → 0.1.46

package/README.md

@@ -891,6 +891,28 @@ function FollowButton({ userUid }: { userUid: string }) {
 }
 ```
 
+### Followers / Followings List
+
+특정 사용자의 팔로워 목록/팔로잉 목록을 페이지네이션으로 조회할 수 있습니다.
+
+```tsx
+import { useFollowers, useFollowings } from '@ph-cms/client-sdk';
+
+function FollowLists({ userUid }: { userUid: string }) {
+  const { data: followers, isLoading: isFollowersLoading } = useFollowers(userUid, { page: 1, limit: 20 });
+  const { data: followings, isLoading: isFollowingsLoading } = useFollowings(userUid, { page: 1, limit: 20 });
+
+  if (isFollowersLoading || isFollowingsLoading) return <div>Loading...</div>;
+
+  return (
+    <div>
+      <p>followers: {followers?.total ?? 0}</p>
+      <p>followings: {followings?.total ?? 0}</p>
+    </div>
+  );
+}
+```
+
 ### `useLikedStats` (Liked Statistics)
 
 특정 사용자가 좋아요를 누른 콘텐츠의 타입별 통계를 조회합니다.
@@ -1316,6 +1338,20 @@ const unfollowResult = await client.user.unfollow('target-user-uid');
 // React Hook 사용
 const { mutate: unfollowUser } = useUnfollowUser();
 unfollowUser('target-user-uid');
+
+// 4. 사용자 팔로워 목록 조회 (Public)
+const followers = await client.user.getFollowers('target-user-uid', { page: 1, limit: 20 });
+// => PagedUserProfileListResponse
+
+// React Hook 사용
+const { data: followerList } = useFollowers('target-user-uid', { page: 1, limit: 20 });
+
+// 5. 사용자 팔로잉 목록 조회 (Public)
+const followings = await client.user.getFollowings('target-user-uid', { page: 1, limit: 20 });
+// => PagedUserProfileListResponse
+
+// React Hook 사용
+const { data: followingList } = useFollowings('target-user-uid', { page: 1, limit: 20 });
 ```
 
 ## Global Ban (글로벌 밴 - 관리자 전용)
@@ -1758,6 +1794,8 @@ const result = await content.list({ channelUid: 'my-channel' });
 | `getFollowStatus(uid: string)` | 현재 로그인 사용자의 대상 유저 팔로우 상태 조회 → `FollowStatusResponse` |
 | `follow(uid: string)` | 특정 사용자 팔로우 → `FollowUserResponse` |
 | `unfollow(uid: string)` | 특정 사용자 언팔로우 → `FollowUserResponse` |
+| `getFollowers(uid: string, params?: { page?: number; limit?: number })` | 특정 사용자의 팔로워 목록 조회 → `PagedUserProfileListResponse` |
+| `getFollowings(uid: string, params?: { page?: number; limit?: number })` | 특정 사용자의 팔로잉 목록 조회 → `PagedUserProfileListResponse` |
 | `updateProfile(uid: string, data: UpdateUserProfileRequest)` | 유저의 프로필 정보 업데이트 → `UserDto` |
 | `getLikedContents(uid: string, params?: Partial<ListLikedContentQuery>)` | 사용자가 좋아요 누른 콘텐츠 목록 조회 → `PagedContentListResponse` |
 | `getLikedStats(uid: string)` | 사용자가 좋아요 누른 콘텐츠 타입별 통계 조회 → `LikedStatsByTypeResponse` |

package/dist/hooks/useUser.d.ts

@@ -1,4 +1,4 @@
-import { ListLikedContentQuery, UpdateUserProfileRequest, BlockUserRequest, SuspendUserRequest } from '@ph-cms/api-contract';
+import { ListLikedContentQuery, ListUserFollowQuery, UpdateUserProfileRequest, BlockUserRequest, SuspendUserRequest } from '@ph-cms/api-contract';
 export declare const termsKeys: {
     all: readonly ["terms"];
     lists: () => readonly ["terms", "list"];
@@ -7,6 +7,14 @@ export declare const userKeys: {
     all: readonly ["users"];
     profile: (uid: string) => readonly ["users", "profile", string];
     followStatus: (uid: string) => readonly ["users", "follow-status", string];
+    followers: (uid: string, params: Partial<ListUserFollowQuery>) => readonly ["users", "followers", string, Partial<{
+        page: number;
+        limit: number;
+    }>];
+    followings: (uid: string, params: Partial<ListUserFollowQuery>) => readonly ["users", "followings", string, Partial<{
+        page: number;
+        limit: number;
+    }>];
 };
 /**
  * Access the current user profile and status.
@@ -66,6 +74,40 @@ export declare const useUserProfile: (uid: string) => import("@tanstack/react-qu
 export declare const useFollowStatus: (uid: string, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
     is_following: boolean;
 }, Error>;
+/**
+ * Hook to fetch followers of a target user.
+ */
+export declare const useFollowers: (uid: string, params?: Partial<ListUserFollowQuery>, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
+    items: {
+        uid: string;
+        username: string | null;
+        display_name: string;
+        avatar_url: string | null;
+        follower_count: number;
+        profile_data: Record<string, any>;
+    }[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}, Error>;
+/**
+ * Hook to fetch followings of a target user.
+ */
+export declare const useFollowings: (uid: string, params?: Partial<ListUserFollowQuery>, enabled?: boolean) => import("@tanstack/react-query").UseQueryResult<{
+    items: {
+        uid: string;
+        username: string | null;
+        display_name: string;
+        avatar_url: string | null;
+        follower_count: number;
+        profile_data: Record<string, any>;
+    }[];
+    total: number;
+    page: number;
+    limit: number;
+    totalPages: number;
+}, Error>;
 /**
  * Hook to update a user's profile.
  * Typically used by a user to update their own profile.

package/dist/hooks/useUser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUnsuspendUser = exports.useSuspendUser = exports.useBlockedUsers = exports.useUnblockUser = exports.useBlockUser = exports.useAgreeTerms = exports.useChannelTerms = exports.useLikedStats = exports.useLikedContents = exports.useUnfollowUser = exports.useFollowUser = exports.useUpdateProfile = exports.useFollowStatus = exports.useUserProfile = exports.useUser = exports.userKeys = exports.termsKeys = void 0;
+exports.useUnsuspendUser = exports.useSuspendUser = exports.useBlockedUsers = exports.useUnblockUser = exports.useBlockUser = exports.useAgreeTerms = exports.useChannelTerms = exports.useLikedStats = exports.useLikedContents = exports.useUnfollowUser = exports.useFollowUser = exports.useUpdateProfile = exports.useFollowings = exports.useFollowers = exports.useFollowStatus = exports.useUserProfile = exports.useUser = exports.userKeys = exports.termsKeys = void 0;
 const react_query_1 = require("@tanstack/react-query");
 const context_1 = require("../context");
 exports.termsKeys = {
@@ -11,6 +11,8 @@ exports.userKeys = {
     all: ['users'],
     profile: (uid) => [...exports.userKeys.all, 'profile', uid],
     followStatus: (uid) => [...exports.userKeys.all, 'follow-status', uid],
+    followers: (uid, params) => [...exports.userKeys.all, 'followers', uid, params],
+    followings: (uid, params) => [...exports.userKeys.all, 'followings', uid, params],
 };
 /**
  * Access the current user profile and status.
@@ -44,6 +46,30 @@ const useFollowStatus = (uid, enabled = true) => {
     });
 };
 exports.useFollowStatus = useFollowStatus;
+/**
+ * Hook to fetch followers of a target user.
+ */
+const useFollowers = (uid, params = {}, enabled = true) => {
+    const client = (0, context_1.usePHCMS)();
+    return (0, react_query_1.useQuery)({
+        queryKey: exports.userKeys.followers(uid, params),
+        queryFn: () => client.user.getFollowers(uid, params),
+        enabled: !!uid && enabled,
+    });
+};
+exports.useFollowers = useFollowers;
+/**
+ * Hook to fetch followings of a target user.
+ */
+const useFollowings = (uid, params = {}, enabled = true) => {
+    const client = (0, context_1.usePHCMS)();
+    return (0, react_query_1.useQuery)({
+        queryKey: exports.userKeys.followings(uid, params),
+        queryFn: () => client.user.getFollowings(uid, params),
+        enabled: !!uid && enabled,
+    });
+};
+exports.useFollowings = useFollowings;
 /**
  * Hook to update a user's profile.
  * Typically used by a user to update their own profile.

package/dist/modules/user.d.ts

@@ -1,4 +1,4 @@
-import { LikedStatsByTypeResponse, ListLikedContentQuery, PagedContentListResponse, UpdateUserProfileRequest, UserDto, UserProfileDto, FollowStatusResponse, FollowUserResponse, BlockUserRequest, BlockUserResponse, PagedBlockedUserListResponse, SuspendUserRequest, SuspendUserResponse } from "@ph-cms/api-contract";
+import { LikedStatsByTypeResponse, ListLikedContentQuery, ListUserFollowQuery, PagedContentListResponse, PagedUserProfileListResponse, UpdateUserProfileRequest, UserDto, UserProfileDto, FollowStatusResponse, FollowUserResponse, BlockUserRequest, BlockUserResponse, PagedBlockedUserListResponse, SuspendUserRequest, SuspendUserResponse } from "@ph-cms/api-contract";
 import { AxiosInstance } from "axios";
 export declare class UserModule {
     private client;
@@ -28,6 +28,20 @@ export declare class UserModule {
      * @param uid - The UID of the target user.
      */
     unfollow(uid: string): Promise<FollowUserResponse>;
+    /**
+     * Retrieves followers of a user.
+     *
+     * @param uid - The UID of the target user.
+     * @param params - Paging parameters.
+     */
+    getFollowers(uid: string, params?: Partial<ListUserFollowQuery>): Promise<PagedUserProfileListResponse>;
+    /**
+     * Retrieves followings of a user.
+     *
+     * @param uid - The UID of the target user.
+     * @param params - Paging parameters.
+     */
+    getFollowings(uid: string, params?: Partial<ListUserFollowQuery>): Promise<PagedUserProfileListResponse>;
     /**
      * Updates a user's profile.
      *

package/dist/modules/user.js

@@ -46,6 +46,36 @@ class UserModule {
             throw new errors_1.ValidationError("UID is required", []);
         return this.client.delete(`${this.prefix}/users/${uid}/follow`);
     }
+    /**
+     * Retrieves followers of a user.
+     *
+     * @param uid - The UID of the target user.
+     * @param params - Paging parameters.
+     */
+    async getFollowers(uid, params = {}) {
+        if (!uid)
+            throw new errors_1.ValidationError("UID is required", []);
+        const validation = api_contract_1.ListUserFollowQuerySchema.safeParse(params);
+        if (!validation.success) {
+            throw new errors_1.ValidationError("Invalid followers list params", validation.error.errors);
+        }
+        return this.client.get(`${this.prefix}/users/${uid}/followers`, { params: validation.data });
+    }
+    /**
+     * Retrieves followings of a user.
+     *
+     * @param uid - The UID of the target user.
+     * @param params - Paging parameters.
+     */
+    async getFollowings(uid, params = {}) {
+        if (!uid)
+            throw new errors_1.ValidationError("UID is required", []);
+        const validation = api_contract_1.ListUserFollowQuerySchema.safeParse(params);
+        if (!validation.success) {
+            throw new errors_1.ValidationError("Invalid followings list params", validation.error.errors);
+        }
+        return this.client.get(`${this.prefix}/users/${uid}/followings`, { params: validation.data });
+    }
     /**
      * Updates a user's profile.
      *

package/dist/types.d.ts

@@ -5,7 +5,7 @@ export type { AuthStatus, PHCMSContextType, PHCMSProviderProps } from './context
 export type { FirebaseAuthSyncProps, UseFirebaseAuthSyncOptions, UseFirebaseAuthSyncReturn } from './hooks/useFirebaseAuthSync';
 export type { StampAvailability, CheckStampAvailabilityParams } from './hooks/useStampTour';
 export type { AnonymousLoginRequest, AuthResponse, FirebaseExchangeRequest, FirebaseRegisterRequest, LoginRequest, RefreshTokenRequest, RegisterRequest, } from '@ph-cms/api-contract';
-export type { UserDto, UserProfileDto, FollowStatusResponse, FollowUserResponse, } from '@ph-cms/api-contract';
+export type { UserDto, UserProfileDto, FollowStatusResponse, FollowUserResponse, ListUserFollowQuery, PagedUserProfileListResponse, } from '@ph-cms/api-contract';
 export type { ChannelDto, CheckHierarchyQuery } from '@ph-cms/api-contract';
 export type { ContentDto, ContentStatDto, ContentMediaDto, ContentStatus, CreateContentRequest, ListContentQuery, PagedContentListResponse, UpdateContentRequest, } from '@ph-cms/api-contract';
 export type { HierarchySetDto } from '@ph-cms/api-contract';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ph-cms/client-sdk",
-  "version": "0.1.45",
+  "version": "0.1.46",
   "description": "Unified PH-CMS Client SDK (React + Core)",
   "keywords": [],
   "license": "MIT",
@@ -30,7 +30,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@ph-cms/api-contract": "^0.1.22",
+    "@ph-cms/api-contract": "^0.1.23",
     "@tanstack/react-query": "^5.0.0",
     "axios": "^1.6.0",
     "zod": "^3.22.4"