@bridge-ai-dev/ecom-chat 1.0.10 → 1.0.11

package/README.md

@@ -1,93 +1,76 @@
-# Ecom Chat - UI
+# Bridge E-commerce Chat widget integration for Next.js
 
+A powerful chat widget integration specifically designed for Next.js and Litium storefronts. It handles complex authentication flows and automatic cart context initialization.
 
+## Features
 
-## Getting started
+- **Automatic Cart Scaling**: Server-side cart creation using Litium's `CreateCart` mutation.
+- **Secure Auth Bridge**: Handles HttpOnly cookies (`.AspNetCore.Identity.Application` and `cart-context`) safely.
+- **Next.js Optimized**: Built for the App Router and React Server Components.
+- **Zero Configuration**: Scaffolding tool to get you started in seconds.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Quick Start
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+Run the following command in your Next.js project root:
 
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://git.bridge-delivery.com/bridge-ai/ecom-chat-ui.git
-git branch -M main
-git push -uf origin main
+```bash
+npx @bridge-ai-dev/ecom-chat
 ```
 
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://git.bridge-delivery.com/bridge-ai/ecom-chat-ui/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+This will:
+1. Create `app/api/bridge-auth/route.ts` (The secure auth bridge)
+2. Create `components/ChatWrapper.tsx` (A pre-configured component wrapper)
 
-***
+## Configuration
 
-# Editing this README
+Add the following environment variables to your `.env.local`:
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+```env
+# Required for the Widget
+NEXT_PUBLIC_BRIDGE_TENANT_ID=your-tenant-uuid
+NEXT_PUBLIC_BRIDGE_WIDGET_URL=https://...
 
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+# Required for server-side cart initialization
+RUNTIME_LITIUM_SERVER_URL=https://your-litium-backend.com
+```
 
 ## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+In your `app/layout.tsx`:
+
+```tsx
+import ChatWrapper from '@/components/ChatWrapper';
+
+export default function RootLayout({ children }) {
+  return (
+    <html>
+      <body>
+        {children}
+        <ChatWrapper />
+      </body>
+    </html>
+  );
+}
+```
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+## How it works
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+The library uses a "Bridge Auth" pattern:
+1. The **ChatComponent** (client-side) calls the `/api/bridge-auth` route.
+2. The **Auth Route** (server-side) reads the secure Litium cookies.
+3. If the **cart-context** cookie is missing, the route automatically performs a `CreateCart` mutation to Litium's GraphQL API.
+4. The route returns the auth data to the widget and forwards any new `Set-Cookie` headers to the browser.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## Customization
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+### `ChatComponent` Props
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `tenantId` | `string` | **Required** | Your Bridge AI tenant ID. |
+| `widgetScriptUrl` | `string` | **Required** | URL of the chat widget script. |
+| `cartCreationMode` | `'server' \| 'client' \| 'none'` | `'server'` | How to handle missing carts. |
 
 ## License
-For open source projects, say how it is licensed.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+MIT

package/bin/cli.js

@@ -21,14 +21,19 @@ const log = {
     step: (msg) => console.log(`${colors.bold}🚀 ${msg}${colors.reset}`)
 };
 
-// Read the API route content from the template file
-const templatePath = path.join(__dirname, '..', 'templates', 'route.ts.template');
-let apiRouteContent;
+// Read the template contents
+const templatesDir = path.join(__dirname, '..', 'templates');
+const routeTemplatePath = path.join(templatesDir, 'route.ts.template');
+const wrapperTemplatePath = path.join(templatesDir, 'ChatWrapper.tsx.template');
+
+let routeTemplateContent;
+let wrapperTemplateContent;
 
 try {
-    apiRouteContent = fs.readFileSync(templatePath, 'utf8');
+    routeTemplateContent = fs.readFileSync(routeTemplatePath, 'utf8');
+    wrapperTemplateContent = fs.readFileSync(wrapperTemplatePath, 'utf8');
 } catch (error) {
-    console.error(`${colors.red}❌ Error reading template file: ${error.message}${colors.reset}`);
+    console.error(`${colors.red}❌ Error reading template files: ${error.message}${colors.reset}`);
     process.exit(1);
 }
 
@@ -39,9 +44,7 @@ function isNextJsProject(cwd) {
         'next.config.mjs',
         'next.config.ts',
         path.join('app', 'layout.tsx'),
-        path.join('app', 'layout.js'),
-        path.join('app', 'page.tsx'),
-        path.join('app', 'page.js')
+        path.join('app', 'app', 'layout.tsx')
     ];
 
     for (const indicator of indicators) {
@@ -115,42 +118,65 @@ function setup() {
 }
 
 function createFiles(cwd) {
-    const targetDir = path.join(cwd, 'app', 'api', 'bridge-auth');
-    const targetFile = path.join(targetDir, 'route.ts');
+    // 1. Create the API Route
+    const apiDir = path.join(cwd, 'app', 'api', 'bridge-auth');
+    const apiFile = path.join(apiDir, 'route.ts');
 
-    // Check if file already exists
-    if (fs.existsSync(targetFile)) {
+    if (fs.existsSync(apiFile)) {
         log.warning('API route already exists at: app/api/bridge-auth/route.ts');
-        log.info('Skipping file creation to avoid overwriting.');
     } else {
-        // Create directory structure
-        if (!fs.existsSync(targetDir)) {
-            fs.mkdirSync(targetDir, { recursive: true });
+        if (!fs.existsSync(apiDir)) {
+            fs.mkdirSync(apiDir, { recursive: true });
             log.success('Created directory: app/api/bridge-auth/');
         }
-
-        // Write the API route file
-        fs.writeFileSync(targetFile, apiRouteContent, 'utf8');
+        fs.writeFileSync(apiFile, routeTemplateContent, 'utf8');
         log.success('Created API route: app/api/bridge-auth/route.ts');
     }
 
+    // 2. Create the ChatWrapper Component
+    // Try to find components directory, fallback to cwd/components
+    let componentsDir = path.join(cwd, 'components');
+    if (!fs.existsSync(componentsDir)) {
+        // Check if there's an src/components
+        const srcComponents = path.join(cwd, 'src', 'components');
+        if (fs.existsSync(srcComponents)) {
+            componentsDir = srcComponents;
+        } else {
+            // Create a components directory if it doesn't exist
+            fs.mkdirSync(componentsDir, { recursive: true });
+            log.success('Created directory: components/');
+        }
+    }
+
+    const wrapperFile = path.join(componentsDir, 'ChatWrapper.tsx');
+
+    if (fs.existsSync(wrapperFile)) {
+        log.warning('ChatWrapper already exists at: components/ChatWrapper.tsx');
+    } else {
+        fs.writeFileSync(wrapperFile, wrapperTemplateContent, 'utf8');
+        log.success(`Created ChatWrapper: ${path.relative(cwd, wrapperFile)}`);
+    }
+
     console.log('\n');
     log.step('Next Steps:');
     console.log('\n');
     console.log('   1. Install the package (if not already):');
     console.log(`      ${colors.yellow}npm install @bridge-ai-dev/ecom-chat${colors.reset}`);
     console.log('\n');
-    console.log('   2. Add the ChatComponent to your layout.tsx:');
-    console.log(`      ${colors.yellow}import { ChatComponent } from '@bridge-ai-dev/ecom-chat';${colors.reset}`);
+    console.log('   2. Add environment variables to your .env.local:');
+    console.log(`      ${colors.yellow}NEXT_PUBLIC_BRIDGE_TENANT_ID=your-tenant-id${colors.reset}`);
+    console.log(`      ${colors.yellow}NEXT_PUBLIC_BRIDGE_WIDGET_URL=https://...${colors.reset}`);
+    console.log(`      ${colors.yellow}RUNTIME_LITIUM_SERVER_URL=https://your-litium-backend.com${colors.reset}`);
     console.log('\n');
-    console.log('   3. Include it in your layout:');
-    console.log(`      ${colors.yellow}<ChatComponent tenantId="your-tenant-uuid" />${colors.reset}`);
+    console.log('   3. Use the ChatWrapper in your app/layout.tsx:');
+    console.log(`      ${colors.yellow}import ChatWrapper from 'components/ChatWrapper';${colors.reset}`);
+    console.log('      ...');
+    console.log(`      ${colors.yellow}<ChatWrapper />${colors.reset}`);
     console.log('\n');
-    console.log('   4. The bridge-auth route automatically creates a cart context');
-    console.log('      if one doesn\'t exist (using the Litium CreateCart mutation).');
-    console.log(`      It uses ${colors.yellow}RUNTIME_LITIUM_SERVER_URL${colors.reset} env var for the Litium backend URL.`);
+    console.log('   4. Verify the bridge-auth route is accessible:');
+    console.log(`      ${colors.blue}http://localhost:3000/api/bridge-auth${colors.reset}`);
     console.log('\n');
-    log.success('Setup complete! 🎉');
+    log.success('Scaffolding complete! 🎉');
     console.log('\n');
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bridge-ai-dev/ecom-chat",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "Bridge E-commerce Chat widget integration for Next.js with Litium authentication",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/templates/ChatWrapper.tsx.template

@@ -0,0 +1,19 @@
+'use client';
+
+import { ChatComponent } from '@bridge-ai-dev/ecom-chat';
+
+/**
+ * ChatWrapper Component
+ * 
+ * This component wraps the Bridge ChatComponent. By default, it uses
+ * 'server' cart creation mode, which relies on the /api/bridge-auth route
+ * to initialize the Litium cart context.
+ */
+export default function ChatWrapper() {
+    return (
+        <ChatComponent
+            tenantId={process.env.NEXT_PUBLIC_BRIDGE_TENANT_ID || ""}
+            widgetScriptUrl={process.env.NEXT_PUBLIC_BRIDGE_WIDGET_URL}
+        />
+    );
+}