@amityco/ulta-ui-kit 1.0.0-alpha.3 → 1.0.0-alpha.30

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@amityco/ulta-ui-kit",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.30",
   "engines": {
-    "node": ">=20",
-    "pnpm": "9"
+    "node": ">=18"
   },
   "module": "dist/esm/index.js",
   "main": "dist/index.js",
@@ -25,12 +24,12 @@
   "types": "dist/index.d.ts",
   "description": "React Ui-Kit for Amity Social Cloud",
   "peerDependencies": {
-    "@amityco/ts-sdk": "6.29.2-ad0d097.0",
+    "@amityco/ts-sdk": "^6.30.0",
     "react": ">=17.0.2",
     "react-dom": ">=17.0.2"
   },
   "devDependencies": {
-    "@amityco/ts-sdk": "6.29.2-ad0d097.0",
+    "@amityco/ts-sdk": "6.30.0",
     "@eslint/js": "^9.4.0",
     "@storybook/addon-a11y": "^7.6.7",
     "@storybook/addon-actions": "^7.6.7",

package/readme.md

@@ -1,21 +1,141 @@
-# Amity Ui-Kit for Web
+# Ulta-Social-Cloud-Ui-Kit for Web
 
 ## Getting started
 
-Before starting to work, please read the following instructions.
-https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2443706407/ASC+Web+UIKit+V4+Governance
+The AmityUIKit provides a comprehensive user interface toolkit to quickly integrate Amity Social features into new or existing websites. This toolkit simplifies the incorporation of social interactions within your projects through an iframe-based integration.
 
-If you have any questions, please ask / discuss with the team.
+### Prerequisites
+
+Before you begin, ensure you have the following installed:
+
+• Node.js (>= 20.x)
+• React.js (>= 18.x)
 
 ### Installation
 
-1. `npm install --save @amityco/ui-kit`
-2. `yarn add @amityco/ui-kit`
+With npm: `npm install --save @amityco/ulta-ui-kit`
+
+With yarn: `yarn add @amityco/ulta-ui-kit`
+
+### Basic Usage
+
+```sh
+import { AmityUiKitProvider, AmityUiKitSocial } from "@amityco/ulta-ui-kit";
+
+import "@amityco/ulta-ui-kit/dist/index.css";
+
+export default function App() {
+  // Retrieve userId from query parameters
+  const urlParams = new URLSearchParams(window.location.search);
+  const userId = urlParams.get("userId");
+  const apiKey = "<your API key here>";
+  const apiRegion = "<your API region here>";
+
+  return (
+    <div className="App">
+      <AmityUiKitProvider
+           apiKey={apiKey}
+           userId={userId}
+           apiRegion={apiRegion}
+       >
+        <AmityUiKitSocial />
+      </AmityUiKitProvider>
+    </div>
+  );
+}
+```
+
+### Iframe Post Message Integration
+
+In React, the component’s state dictates the behavior and rendering of the component. When the state changes, React automatically triggers a re-render of the component, updating the DOM where necessary. In your application, the userId is stored in the component’s state using the useState hook. This state determines the URL of the iframe where the Amity UIKit is loaded. When the userId state changes, React recognizes this change and re-renders the component, including the iframe, with the updated URL.
+
+When an anonymous user exceeds three clicks, the UIKit will emit a ‘anonymousNeedsLogin’ postMessage event. Below is a code example demonstrating how to receive this postMessage event from the UIKit Iframe:
+
+```sh
+import React, { useState, useEffect } from 'react';
+
+export default function App() {
+  // `userId` is managed as a state variable and will be updated post-login
+  const [userId, setUserId] = useState('anonymous-xxxx');
+
+  // Handle the postMessage event from the iframe
+  useEffect(() => {
+    const handleIframeMessage = event => {
+      if (event.data === 'anonymousNeedsLogin') {
+        // Prompt user to log in
+        // Logic to display login dialog should be implemented here
+      }
+    };
+
+    // Listen for messages from the iframe
+    window.addEventListener('message', handleIframeMessage);
+
+    // Cleanup the event listener on component unmount
+    return () => {
+      window.removeEventListener('message', handleIframeMessage);
+    };
+  }, []);
+
+  // Function to handle setting a new `userId` after the user logs in
+  const handleSetUserId = newValue => {
+    setUserId(newValue);
+  };
+
+  return (
+    <div>
+      // Assume that this is Ulta login prompt
+      <input
+        type="text"
+        id="name"
+        placeholder="Enter new User ID"
+        onChange={(e) => handleSetUserId(e.target.value)}
+      />
+      <button onClick={() => handleSetUserId(document.getElementById('name').value)}>
+        Set User ID
+      </button>
+      <iframe
+        style={{ width: '100%', height: '80vh' }}
+        title="Communities"
+        src={`https://urlToUikit.com?userId=${userId}`}
+      />
+    </div>
+  );
+}
+```
+
+### Anonymous User Flow
+
+**Authenticated Users**
+
+1. Access and Authentication:
+
+- Users enter Ulta Web and navigate to the community tab.
+- Ulta Web contacts Ulta Authentication Service to verify if the user is logged in.
+
+2. Token Handling:
+
+- If authenticated, Ulta Web requests an Amity authentication token from Ulta Server.
+- Ulta Server forwards this request to Amity Server, which returns the token.
+
+3. UIKit Initialization:
+
+- Ulta Web instructs Ulta Iframe to initialize Amity UIKit using the authenticated Ulta User ID and token.
+- Amity UIKit is then presented to the user, allowing continued interaction under their Ulta ID.
+
+**Anonymous Users**
+
+1. Access as Anonymous:
+
+- If not logged in, the same token request is made to handle session management.
+- Amity UIKit is initialized as ‘anonymous’, allowing limited interaction.
+
+2. Exceeded Interaction Limit:
 
-### Documentation
+- If anonymous interactions exceed limits, Amity UIKit informs Ulta Iframe, triggering a notification to Ulta Web.
+- A login dialogue is presented to the user.
 
-Please refer to our online documentation at https://docs.amity.co or contact a Ui-Kit representative at \* \*developers@amity.co** for support.
+3. Login Decision:
 
-## Contributing
+- If the user logs in, Ulta Authentication Service authenticates the user, and the token process repeats to reinitialize Amity UIKit with the Ulta User ID.
 
-See [our contributing guide](https://github.com/EkoCommunications/AmityUiKitWeb/blob/develop/CONTRIBUTING.md)
+![Diagram Sept 4 from Mermaid Chart (1)](https://github.com/user-attachments/assets/e62d0e3e-4b00-445d-b8ea-cda1b72ab5f0)