@amityco/ui-kit-open-source 4.12.0 → 4.14.0

package/dist/index.d.mts

@@ -62,6 +62,12 @@ type DefaultConfig = {
 type NetworkConfig = {
     config: DefaultConfig;
 };
+declare const enum UserAccessTypes {
+    ALL = "all",
+    SIGNED_IN_USER_ONLY = "singed_in_user_only",
+    NONE = "none"
+}
+type UserAccess = `${UserAccessTypes}`;
 interface Config {
     preferred_theme?: 'light' | 'dark' | 'default';
     theme?: {
@@ -74,6 +80,14 @@ interface Config {
     customizations?: {
         [key: string]: GetConfigReturnValue;
     };
+    feature_flags?: {
+        post?: {
+            clip?: {
+                can_create: UserAccess;
+                can_view_tab: UserAccess;
+            };
+        };
+    };
 }
 
 interface PostDetailPageProps {
@@ -477,6 +491,11 @@ interface PageBehavior {
             communityId: string;
         }): void;
     };
+    AmityGlobalBehavior?: {
+        handleVisitorUserAction?(): void;
+        handleNonMemberAction?(): void;
+        handleNonFollowerAction?(): void;
+    };
 }
 
 type AmityUIKitConfig = Config;
@@ -492,7 +511,7 @@ interface AmityUIKitProviderProps {
         mqtt?: string;
         upload?: string;
     };
-    userId: string;
+    userId?: string;
     displayName?: string;
     postRendererConfig?: any;
     theme?: Record<string, unknown>;
@@ -518,6 +537,12 @@ interface AmityUIKitProviderProps {
     onConnected?: () => void;
     onDisconnected?: () => void;
     getAuthToken?: () => Promise<string>;
+    authSignatureExpiresAt?: string;
+    getAuthSignature?: ({ deviceId, authSignatureExpiresAt, }: {
+        deviceId: string;
+        authSignatureExpiresAt: string;
+    }) => Promise<string>;
+    isBotUser?: boolean;
     configs?: AmityUIKitConfig;
     activeRoute?: AmityRoute;
     onRouteChange?: (route: AmityRoute) => void;
@@ -712,6 +737,20 @@ interface SessionHandler {
      */
     sessionWillRenewAccessToken(renewal: Amity.AccessTokenRenewal): void;
 }
+/**
+ * Interface for the registerDevice parameters.
+ */
+interface RegisterDeviceParams {
+    userId?: string;
+    displayName?: string;
+    sessionHandler: SessionHandler;
+    authToken?: string;
+    authSignatureParams?: Amity.ConnectClientAsVisitorParams;
+    onConnectionStatusChange?: (state: Amity.SessionStates) => void;
+    onConnected?: () => void;
+    onDisconnected?: () => void;
+    onGlobalBanned?: (payload: Amity.UserPayload) => void;
+}
 /**
  * Manages the Amity SDK client and authentication state.
  */
@@ -745,15 +784,9 @@ declare class AmityUIKitManager {
     }): void;
     /**
      * Registers a device with the Amity SDK and handles the login process.
-     * @param userId - The user ID to be used for login.
-     * @param displayName - The display name of the user.
-     * @param sessionHandler - The session handler for access token renewal.
-     * @param authToken - The authentication token to be used for login.
-     * @param onConnectionStatusChange - The callback function for connection status changes.
-     * @param onConnected - The callback function to be called when connected.
-     * @param onDisconnected - The callback function to be called when disconnected.
+     * @param params - The parameters object containing all registration options.
      */
-    static registerDevice(userId: string, displayName: string, sessionHandler: SessionHandler, authToken?: string, onConnectionStatusChange?: (state: Amity.SessionStates) => void, onConnected?: () => void, onDisconnected?: () => void, onGlobalBanned?: (payload: Amity.UserPayload) => void): Promise<void>;
+    static registerDevice({ userId, displayName, sessionHandler, authToken, authSignatureParams, onConnectionStatusChange, onConnected, onDisconnected, onGlobalBanned, }: RegisterDeviceParams): Promise<void>;
     /**
      * Sets the AmityClient instance to be used by the AmityUIKitManager.
      * This method is useful when sharing the AmityClient instance between different parts of the application.
@@ -1053,7 +1086,7 @@ type CommentTrayProps = {
     referenceId: string;
     community: Amity.Community;
     shouldAllowCreation?: boolean;
-    shouldAllowInteraction: boolean;
+    shouldAllowInteraction?: boolean;
     referenceType: Amity.CommentReferenceType;
 };
 declare const CommentTray: ({ referenceId, pageId, referenceType, shouldAllowCreation, shouldAllowInteraction, community, }: CommentTrayProps) => React.JSX.Element;

package/dist/index.d.ts

@@ -62,6 +62,12 @@ type DefaultConfig = {
 type NetworkConfig = {
     config: DefaultConfig;
 };
+declare const enum UserAccessTypes {
+    ALL = "all",
+    SIGNED_IN_USER_ONLY = "singed_in_user_only",
+    NONE = "none"
+}
+type UserAccess = `${UserAccessTypes}`;
 interface Config {
     preferred_theme?: 'light' | 'dark' | 'default';
     theme?: {
@@ -74,6 +80,14 @@ interface Config {
     customizations?: {
         [key: string]: GetConfigReturnValue;
     };
+    feature_flags?: {
+        post?: {
+            clip?: {
+                can_create: UserAccess;
+                can_view_tab: UserAccess;
+            };
+        };
+    };
 }
 
 interface PostDetailPageProps {
@@ -477,6 +491,11 @@ interface PageBehavior {
             communityId: string;
         }): void;
     };
+    AmityGlobalBehavior?: {
+        handleVisitorUserAction?(): void;
+        handleNonMemberAction?(): void;
+        handleNonFollowerAction?(): void;
+    };
 }
 
 type AmityUIKitConfig = Config;
@@ -492,7 +511,7 @@ interface AmityUIKitProviderProps {
         mqtt?: string;
         upload?: string;
     };
-    userId: string;
+    userId?: string;
     displayName?: string;
     postRendererConfig?: any;
     theme?: Record<string, unknown>;
@@ -518,6 +537,12 @@ interface AmityUIKitProviderProps {
     onConnected?: () => void;
     onDisconnected?: () => void;
     getAuthToken?: () => Promise<string>;
+    authSignatureExpiresAt?: string;
+    getAuthSignature?: ({ deviceId, authSignatureExpiresAt, }: {
+        deviceId: string;
+        authSignatureExpiresAt: string;
+    }) => Promise<string>;
+    isBotUser?: boolean;
     configs?: AmityUIKitConfig;
     activeRoute?: AmityRoute;
     onRouteChange?: (route: AmityRoute) => void;
@@ -712,6 +737,20 @@ interface SessionHandler {
      */
     sessionWillRenewAccessToken(renewal: Amity.AccessTokenRenewal): void;
 }
+/**
+ * Interface for the registerDevice parameters.
+ */
+interface RegisterDeviceParams {
+    userId?: string;
+    displayName?: string;
+    sessionHandler: SessionHandler;
+    authToken?: string;
+    authSignatureParams?: Amity.ConnectClientAsVisitorParams;
+    onConnectionStatusChange?: (state: Amity.SessionStates) => void;
+    onConnected?: () => void;
+    onDisconnected?: () => void;
+    onGlobalBanned?: (payload: Amity.UserPayload) => void;
+}
 /**
  * Manages the Amity SDK client and authentication state.
  */
@@ -745,15 +784,9 @@ declare class AmityUIKitManager {
     }): void;
     /**
      * Registers a device with the Amity SDK and handles the login process.
-     * @param userId - The user ID to be used for login.
-     * @param displayName - The display name of the user.
-     * @param sessionHandler - The session handler for access token renewal.
-     * @param authToken - The authentication token to be used for login.
-     * @param onConnectionStatusChange - The callback function for connection status changes.
-     * @param onConnected - The callback function to be called when connected.
-     * @param onDisconnected - The callback function to be called when disconnected.
+     * @param params - The parameters object containing all registration options.
      */
-    static registerDevice(userId: string, displayName: string, sessionHandler: SessionHandler, authToken?: string, onConnectionStatusChange?: (state: Amity.SessionStates) => void, onConnected?: () => void, onDisconnected?: () => void, onGlobalBanned?: (payload: Amity.UserPayload) => void): Promise<void>;
+    static registerDevice({ userId, displayName, sessionHandler, authToken, authSignatureParams, onConnectionStatusChange, onConnected, onDisconnected, onGlobalBanned, }: RegisterDeviceParams): Promise<void>;
     /**
      * Sets the AmityClient instance to be used by the AmityUIKitManager.
      * This method is useful when sharing the AmityClient instance between different parts of the application.
@@ -1053,7 +1086,7 @@ type CommentTrayProps = {
     referenceId: string;
     community: Amity.Community;
     shouldAllowCreation?: boolean;
-    shouldAllowInteraction: boolean;
+    shouldAllowInteraction?: boolean;
     referenceType: Amity.CommentReferenceType;
 };
 declare const CommentTray: ({ referenceId, pageId, referenceType, shouldAllowCreation, shouldAllowInteraction, community, }: CommentTrayProps) => React.JSX.Element;