@react-native-kakao/user 3.1.0-next.1 → 3.1.0-next.2

package/src/index.ts

@@ -1,5 +1,5 @@
 import { is } from '@mj-studio/js-util';
-import { kAssert } from '@react-native-kakao/core';
+import { kAssert, kCreateWebError } from '@react-native-kakao/core';
 
 import Native from './spec/NativeKakaoUser';
 import { validateShippingAddressOptions } from './validateShippingAddressOptions';
@@ -25,13 +25,18 @@ export type KakaoCodeTokenOptions = {
 const minActivityRequestCode = -2147483648;
 const maxActivityRequestCode = 2147483647;
 
+export type KakaoTalkLaunchMethod = 'UniversalLink' | 'CustomScheme';
+
+const defaultTalkLaunchMethod: KakaoTalkLaunchMethod = 'UniversalLink';
+const webOnlyErrorCode = 'Package-UnsupportedPlatform';
+
 export interface KakaoScopeInfo {
   id: string;
   agreed: boolean;
   displayName: string;
-  revocable?: boolean;
+  revocable?: boolean | null;
   using: boolean;
-  delegated?: boolean;
+  delegated?: boolean | null;
   type: string;
 }
 export interface KakaoServiceTerms {
@@ -40,6 +45,7 @@ export interface KakaoServiceTerms {
   agreed: boolean;
   required: boolean;
   revocable: boolean;
+  agreedBy?: 'KAUTH' | 'KAPI' | 'unknown';
 }
 export type KakaoRevokedServiceTerms = {
   tag: string;
@@ -71,14 +77,15 @@ export interface KakaoShippingAddress {
 }
 export interface KakaoUser {
   id: number;
+  properties: Record<string, string>;
   hasSignedUp?: boolean | null;
   uuid?: string | null;
   groupUserToken?: string | null;
-  email: string;
+  email?: string | null;
   name?: string | null;
-  nickname: string;
-  profileImageUrl: string;
-  thumbnailImageUrl: string;
+  nickname?: string | null;
+  profileImageUrl?: string | null;
+  thumbnailImageUrl?: string | null;
   isDefaultImage?: boolean | null;
   phoneNumber?: string | null;
   ageRange?: string | null;
@@ -87,28 +94,28 @@ export interface KakaoUser {
   isLeapMonth?: boolean | null;
   birthyear?: string | null;
   gender?: string | null;
-  isEmailValid: boolean;
-  isEmailVerified: boolean;
-  isKorean?: boolean;
-  ageRangeNeedsAgreement?: boolean;
-  birthdayNeedsAgreement?: boolean;
-  birthyearNeedsAgreement?: boolean;
-  emailNeedsAgreement?: boolean;
-  genderNeedsAgreement?: boolean;
-  isKoreanNeedsAgreement?: boolean;
-  phoneNumberNeedsAgreement?: boolean;
-  profileNeedsAgreement?: boolean;
-  nameNeedsAgreement?: boolean;
-  profileImageNeedsAgreement?: boolean;
-  profileNicknameNeedsAgreement?: boolean;
+  isEmailValid?: boolean | null;
+  isEmailVerified?: boolean | null;
+  isKorean?: boolean | null;
+  ageRangeNeedsAgreement?: boolean | null;
+  birthdayNeedsAgreement?: boolean | null;
+  birthyearNeedsAgreement?: boolean | null;
+  emailNeedsAgreement?: boolean | null;
+  genderNeedsAgreement?: boolean | null;
+  isKoreanNeedsAgreement?: boolean | null;
+  phoneNumberNeedsAgreement?: boolean | null;
+  profileNeedsAgreement?: boolean | null;
+  nameNeedsAgreement?: boolean | null;
+  profileImageNeedsAgreement?: boolean | null;
+  profileNicknameNeedsAgreement?: boolean | null;
   legalName?: string | null;
   legalNameNeedsAgreement?: boolean | null;
   legalBirthDate?: string | null;
-  legalBirthDateNeedsAgreement?: boolean;
+  legalBirthDateNeedsAgreement?: boolean | null;
   legalGender?: 'female' | 'male' | null;
   legalGenderNeedsAgreement?: boolean | null;
-  connectedAt?: number;
-  synchedAt?: number;
+  connectedAt?: number | null;
+  synchedAt?: number | null;
 }
 export interface KakaoAccessTokenInfo {
   id?: number;
@@ -124,6 +131,7 @@ export function login({
   loginHint,
   channelPublicIds,
   android,
+  ios,
 }: {
   serviceTerms?: string[];
   prompts?: ('Login' | 'Create' | 'Cert' | 'SelectAccount')[];
@@ -133,6 +141,7 @@ export function login({
   loginHint?: string;
   channelPublicIds?: string[];
   android?: { requestCode?: number };
+  ios?: { launchMethod?: KakaoTalkLaunchMethod };
   web?: {
     redirectUri: string;
     scope?: string[];
@@ -179,6 +188,7 @@ export function login({
     serviceTerms ?? [],
     prompts ?? [],
     useKakaoAccountLogin ?? false,
+    ios?.launchMethod ?? defaultTalkLaunchMethod,
     scopes ?? [],
     nonce,
     loginHint,
@@ -208,13 +218,13 @@ export function loginWithKakao({
   serviceTerms?: string[];
   ios?: {
     orientation?: 'auto' | 'portrait' | 'landscape';
-    launchMethod?: 'UniversalLink' | 'CustomScheme';
+    launchMethod?: KakaoTalkLaunchMethod;
   };
 } = {}): Promise<KakaoLoginToken> {
   return Native.loginWithKakao(
     uiMode,
     ios?.orientation ?? 'auto',
-    ios?.launchMethod ?? 'UniversalLink',
+    ios?.launchMethod ?? defaultTalkLaunchMethod,
     prompts ?? [],
     loginHint,
     nonce,
@@ -264,12 +274,12 @@ export function refreshToken({
   return Native.refreshToken(token, ios?.loggingEnabled ?? true);
 }
 
-export function logout() {
-  return Native.logout();
+export async function logout() {
+  await Native.logout();
 }
 
-export function unlink() {
-  return Native.unlink();
+export async function unlink() {
+  await Native.unlink();
 }
 
 export function isLogined() {
@@ -286,7 +296,11 @@ export function scopes(scopes?: string[]): Promise<KakaoScopeInfo[]> {
   return Native.scopes(scopes);
 }
 
-export function revokeScopes(scopes: string[]): Promise<void> {
+export async function revokeScopes(scopes: string[]): Promise<void> {
+  await Native.revokeScopes(scopes);
+}
+
+export function revokeScopesWithResult(scopes: string[]): Promise<KakaoScopeInfo[]> {
   return Native.revokeScopes(scopes);
 }
 
@@ -323,9 +337,10 @@ export function selectShippingAddress(): Promise<number> {
 }
 
 export function me({
+  propertyKeys,
   secureResource = true,
-}: { secureResource?: boolean } = {}): Promise<KakaoUser> {
-  return Native.me(secureResource);
+}: { propertyKeys?: string[]; secureResource?: boolean } = {}): Promise<KakaoUser> {
+  return Native.me(propertyKeys, secureResource);
 }
 
 export async function issueAccessTokenWithCode({
@@ -342,16 +357,22 @@ export function getAccessToken(): Promise<KakaoAccessTokenInfo> {
   return Native.getAccessToken();
 }
 
-export function updateProfile({
+export async function updateProfile({
   properties,
 }: {
   properties: Record<string, string>;
 }): Promise<void> {
-  return Native.updateProfile(properties);
+  await Native.updateProfile(properties);
 }
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-export function setAccessTokenWeb(token: string) {}
+export function setAccessTokenWeb(token: string): void {
+  kCreateWebError({
+    code: webOnlyErrorCode,
+    message: '[setAccessTokenWeb] This API is only supported on web.',
+  });
+}
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 export async function issueAccessTokenWithCodeWeb(params: {
   redirectUri: string;
@@ -367,7 +388,10 @@ export async function issueAccessTokenWithCodeWeb(params: {
   refreshTokenExpiresIn: number;
   scope?: string;
 }> {
-  return {} as any;
+  kCreateWebError({
+    code: webOnlyErrorCode,
+    message: '[issueAccessTokenWithCodeWeb] This API is only supported on web.',
+  });
 }
 
 const KakaoUser = {
@@ -383,6 +407,7 @@ const KakaoUser = {
   isKakaoTalkLoginAvailable,
   scopes,
   revokeScopes,
+  revokeScopesWithResult,
   serviceTerms,
   revokeServiceTerms,
   shippingAddresses,

package/src/index.web.ts

@@ -11,6 +11,7 @@ import {
 import {
   type KakaoLoginToken,
   type KakaoScopeInfo,
+  type KakaoServiceTerms,
   type KakaoShippingAddressResult,
   type KakaoUser as KakaoUserProfile,
   type KakaoUserAPI,
@@ -211,17 +212,12 @@ const KakaoUser: KakaoUserAPI = {
         data: scopes?.length ? { scopes } : undefined,
       });
 
-      return camelCaseObject(response.scopes) as KakaoScopeInfo[];
-    }),
-  revokeScopes: (scopes: string[]) =>
-    kRunWebAPI(async () => {
-      await Kakao.API.request({
-        url: '/v2/user/revoke/scopes',
-        data: {
-          scopes,
-        },
-      });
+      return camelCaseObject(response.scopes ?? []) as KakaoScopeInfo[];
     }),
+  revokeScopes: async (scopes: string[]) => {
+    await revokeScopesWithResult(scopes);
+  },
+  revokeScopesWithResult,
   serviceTerms: ({ result, tags } = {}) =>
     kRunWebAPI(async () => {
       const response: {
@@ -232,6 +228,7 @@ const KakaoUser: KakaoUserAPI = {
               agreed: boolean;
               required: boolean;
               revocable: boolean;
+              agreed_by?: string | null;
             }[]
           | null;
       } = await Kakao.API.request({
@@ -239,13 +236,22 @@ const KakaoUser: KakaoUserAPI = {
         data: filterNonNullishKeys({ result, tags: tags?.join(',') }),
       });
 
-      return (response.service_terms ?? []).map((term) => ({
-        tag: term.tag,
-        agreedAt: term.agreed_at ? isoToUnix(term.agreed_at) : undefined,
-        agreed: term.agreed,
-        required: term.required,
-        revocable: term.revocable,
-      }));
+      return (response.service_terms ?? []).map(
+        (term): KakaoServiceTerms =>
+          filterNonNullishKeys({
+            tag: term.tag,
+            agreedAt: term.agreed_at ? isoToUnix(term.agreed_at) : undefined,
+            agreed: term.agreed,
+            required: term.required,
+            revocable: term.revocable,
+            agreedBy:
+              term.agreed_by == null
+                ? undefined
+                : term.agreed_by === 'KAUTH' || term.agreed_by === 'KAPI'
+                  ? term.agreed_by
+                  : 'unknown',
+          }),
+      );
     }),
   revokeServiceTerms: (tags) =>
     kRunWebAPI(async () => {
@@ -318,11 +324,17 @@ const KakaoUser: KakaoUserAPI = {
     kRunWebAPI(async () => {
       await Kakao.API.request({ url: '/v1/user/update_profile', data: { properties } });
     }),
-  me: ({ secureResource = true } = {}) =>
+  me: ({ propertyKeys, secureResource = true } = {}) =>
     kRunWebAPI(async () => {
-      const ret = camelCaseObject(
-        await Kakao.API.request({ url: '/v2/user/me', data: { secure_resource: secureResource } }),
-      ) as {
+      const response: { properties?: Record<string, string> } = await Kakao.API.request({
+        url: '/v2/user/me',
+        data: filterNonNullishKeys({
+          property_keys: propertyKeys,
+          secure_resource: secureResource,
+        }),
+      });
+
+      const ret = camelCaseObject(response) as {
         id: number;
         hasSignedUp?: boolean | null;
         forPartner?: { uuid?: string };
@@ -346,6 +358,7 @@ const KakaoUser: KakaoUserAPI = {
 
       return {
         id: ret.id,
+        properties: response.properties ?? {},
         hasSignedUp: ret.hasSignedUp ?? null,
         uuid: ret.forPartner?.uuid ?? null,
         groupUserToken: ret.groupUserToken ?? null,
@@ -388,6 +401,17 @@ const KakaoUser: KakaoUserAPI = {
     }),
 };
 
+export function revokeScopesWithResult(scopes: string[]): Promise<KakaoScopeInfo[]> {
+  return kRunWebAPI(async () => {
+    const response = await Kakao.API.request({
+      url: '/v2/user/revoke/scopes',
+      data: { scopes },
+    });
+
+    return camelCaseObject(response.scopes ?? []) as KakaoScopeInfo[];
+  });
+}
+
 export const {
   loginWithKakao,
   refreshToken,

package/src/spec/NativeKakaoUser.ts

@@ -18,6 +18,7 @@ export interface Spec extends TurboModule {
     serviceTerms: string[],
     prompts: string[],
     useKakaoAccountLogin: boolean,
+    iosLaunchMethod: string,
     scopes?: string[],
     nonce?: string,
     loginHint?: string,
@@ -46,7 +47,7 @@ export interface Spec extends TurboModule {
   isLogined(): Promise<boolean>;
   hasToken(): Promise<boolean>;
   scopes(scopes?: string[]): Promise<KakaoScopeInfo[]>;
-  revokeScopes(scopes: string[]): Promise<void>;
+  revokeScopes(scopes: string[]): Promise<KakaoScopeInfo[]>;
   serviceTerms(result?: string, tags?: string[]): Promise<KakaoServiceTerms[]>;
   revokeServiceTerms(tags: string[]): Promise<KakaoRevokedServiceTerms[]>;
   shippingAddresses(
@@ -55,7 +56,7 @@ export interface Spec extends TurboModule {
     pageSize?: number,
   ): Promise<KakaoShippingAddressResult>;
   selectShippingAddress(): Promise<number>;
-  me(secureResource?: boolean): Promise<KakaoUser>;
+  me(propertyKeys?: string[], secureResource?: boolean): Promise<KakaoUser>;
   updateProfile(properties: UnsafeObject): Promise<void>;
   getAccessToken(): Promise<KakaoAccessTokenInfo>;
 }