ordify-chat-widget 1.0.26 → 1.0.28

package/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.27] - 2024-12-19
+
+### Added
+- **System Context Support**: New `initialContext` prop allows sending hidden system information to AI agents
+- **GitHub Packages Mirror**: Package now automatically mirrors to GitHub Packages after NPM publishing
+- **Automated Publishing**: GitHub Actions workflow for seamless publishing on main branch merges
+- **Enhanced Documentation**: Updated README with proper registry usage instructions
+
+### Changed
+- Package name updated to `@ordify-ai/chat-widget` for GitHub Packages compatibility
+- Improved auto-scroll behavior with better conversation component structure
+- Enhanced floating button positioning with proper prop support
+
+### Technical
+- Added `.npmrc` configuration for GitHub Packages registry
+- Created GitHub Actions workflow for NPM-first publishing with GitHub Packages mirroring
+- Updated package.json with proper scoped naming and publishConfig
+- **NPM remains the single source of truth** for versioning
+
 ## [1.0.0] - 2024-01-16
 
 ### Added

package/README.md

@@ -14,6 +14,8 @@ A professional, production-ready React chat widget that enables seamless integra
 
 Before integrating the chat widget, ensure you have:
 
+- **Node.js**: 18.0.0 or higher
+- **npm**: 9.0.0 or higher  
 - **API Key**: Available in your Ordify dashboard (Account → Settings → API)
 - **Agent ID**: Found in your agent configuration panel within the Ordify application
 - **React Application**: Compatible with React 18+ and modern build tools
@@ -38,14 +40,26 @@ Before integrating the chat widget, ensure you have:
 
 ### 1. Install the Library
 
+**From NPM (Recommended):**
 ```bash
 npm install ordify-chat-widget
 ```
 
+**From GitHub Packages (Mirror):**
+```bash
+npm install @ordify-ai/chat-widget
+```
+
 ### 2. Add to Your React App
 
+**If using NPM package (recommended):**
 ```tsx
 import { OrdifyChat } from 'ordify-chat-widget'
+```
+
+**If using GitHub Packages mirror:**
+```tsx
+import { OrdifyChat } from '@ordify-ai/chat-widget'
 
 function App() {
   return (
@@ -62,6 +76,23 @@ function App() {
 
 **That's it!** No CSS imports, no additional setup. The library includes all necessary styles automatically.
 
+### GitHub Packages Setup (Optional)
+
+GitHub Packages serves as a mirror of the NPM package. If you need to use it, configure authentication:
+
+1. **Create a Personal Access Token** with `read:packages` scope
+2. **Configure npm authentication:**
+   ```bash
+   npm login --scope=@ordify-ai --auth-type=legacy --registry=https://npm.pkg.github.com
+   ```
+3. **Or add to your `.npmrc` file:**
+   ```
+   @ordify-ai:registry=https://npm.pkg.github.com
+   //npm.pkg.github.com/:_authToken=YOUR_TOKEN
+   ```
+
+> **Note**: We recommend using the NPM version (`ordify-chat-widget`) as it's the primary registry and source of truth.
+
 ## 🎨 Chat Modes
 
 ### Floating Chat (Recommended for websites)
@@ -345,6 +376,11 @@ export default function HomePage() {
 
 ### Setup
 ```bash
+# Ensure you have Node.js 18+ and npm 9+
+node --version  # Should be 18.0.0 or higher
+npm --version   # Should be 9.0.0 or higher
+
+# Clone and setup
 git clone https://github.com/ordify-ai/chat-widget.git
 cd chat-widget
 npm install
@@ -356,6 +392,23 @@ npm run dev
 npm run build
 ```
 
+### Publishing
+
+**Automatic Publishing**: This package is automatically published to NPM when changes are merged to the `main` branch, with GitHub Packages serving as a mirror.
+
+- **NPM**: Primary registry (`ordify-chat-widget`) - **source of truth**
+- **GitHub Packages**: Mirror registry (`@ordify-ai/chat-widget`) - automatic backup
+- **Version Sync**: GitHub Packages mirrors NPM versions exactly
+
+**Manual Publishing** (if needed):
+```bash
+# Publish to NPM
+npm publish --registry=https://registry.npmjs.org/
+
+# Publish to GitHub Packages
+npm publish --registry=https://npm.pkg.github.com
+```
+
 ### Integration Examples
 See the [`examples/integration/`](./examples/integration/) directory for ready-to-copy code snippets for different frameworks and use cases.
 

package/dist/components/EmbeddedChat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EmbeddedChat.d.ts","sourceRoot":"","sources":["../../src/components/EmbeddedChat.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAe3D,UAAU,iBAAiB;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,iBAAiB,2CAgH/D"}
+{"version":3,"file":"EmbeddedChat.d.ts","sourceRoot":"","sources":["../../src/components/EmbeddedChat.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAe3D,UAAU,iBAAiB;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,iBAAiB,2CAyH/D"}

package/dist/components/FloatingChat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FloatingChat.d.ts","sourceRoot":"","sources":["../../src/components/FloatingChat.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAiB3D,UAAU,iBAAiB;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,iBAAiB,2CAiK/D"}
+{"version":3,"file":"FloatingChat.d.ts","sourceRoot":"","sources":["../../src/components/FloatingChat.tsx"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAiB3D,UAAU,iBAAiB;IACzB,MAAM,EAAE,YAAY,CAAA;IACpB,IAAI,EAAE,mBAAmB,CAAA;CAC1B;AAED,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,iBAAiB,2CA2L/D"}

package/dist/components/MarkdownRenderer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MarkdownRenderer.d.ts","sourceRoot":"","sources":["../../src/components/MarkdownRenderer.tsx"],"names":[],"mappings":"AAEA,UAAU,qBAAqB;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,gBAAgB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,qBAAqB,2CAqG7E"}
+{"version":3,"file":"MarkdownRenderer.d.ts","sourceRoot":"","sources":["../../src/components/MarkdownRenderer.tsx"],"names":[],"mappings":"AA2CA,UAAU,qBAAqB;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAgB,gBAAgB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,qBAAqB,2CA8K7E"}

package/dist/components/styled/ChatComponents.d.ts

@@ -5,7 +5,10 @@ export declare const ChatMessage: import('styled-components/dist/types').IStyled
 export declare const ChatInput: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components').FastOmit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 export declare const ProfessionalInput: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components').FastOmit<import('react').DetailedHTMLProps<import('react').TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement>, never>> & string;
 export declare const SendButton: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components').FastOmit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, never>> & string;
-export declare const FloatingButton: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components').FastOmit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, never>> & string;
+export declare const FloatingButton: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components/dist/types').Substitute<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, {
+    $position?: string;
+    $primaryColor?: string;
+}>> & string;
 export declare const ChatWindow: import('styled-components/dist/types').IStyledComponentBase<"web", import('styled-components/dist/types').Substitute<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, {
     $position: string;
 }>> & string;

package/dist/components/styled/ChatComponents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChatComponents.d.ts","sourceRoot":"","sources":["../../../src/components/styled/ChatComponents.tsx"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,6NAgBtB,CAAA;AAGD,eAAO,MAAM,WAAW;aAAyB,OAAO;YA8BvD,CAAA;AAGD,eAAO,MAAM,SAAS,6NAYrB,CAAA;AAGD,eAAO,MAAM,iBAAiB,+OA4C7B,CAAA;AAGD,eAAO,MAAM,UAAU,yOAgCtB,CAAA;AAGD,eAAO,MAAM,cAAc,yOAgC1B,CAAA;AAGD,eAAO,MAAM,UAAU;eAA2B,MAAM;YAiCvD,CAAA;AAGD,eAAO,MAAM,UAAU;mBAA+B,MAAM;YAqB3D,CAAA;AAGD,eAAO,MAAM,WAAW,yOAqBvB,CAAA;AAGD,eAAO,MAAM,YAAY,6NAuCxB,CAAA;AAGD,eAAO,MAAM,WAAW,6NA+BvB,CAAA;AAGD,eAAO,MAAM,SAAS;aAAyB,OAAO;YAQrD,CAAA;AAGD,eAAO,MAAM,YAAY,6NAUxB,CAAA;AAGD,eAAO,MAAM,YAAY;eAA2B,MAAM;YAwBzD,CAAA"}
+{"version":3,"file":"ChatComponents.d.ts","sourceRoot":"","sources":["../../../src/components/styled/ChatComponents.tsx"],"names":[],"mappings":"AAGA,eAAO,MAAM,UAAU,6NAgBtB,CAAA;AAGD,eAAO,MAAM,WAAW;aAAyB,OAAO;YAyCvD,CAAA;AAGD,eAAO,MAAM,SAAS,6NAiBrB,CAAA;AAGD,eAAO,MAAM,iBAAiB,+OA2D7B,CAAA;AAGD,eAAO,MAAM,UAAU,yOAgCtB,CAAA;AAgBD,eAAO,MAAM,cAAc;gBAA+B,MAAM;oBAAkB,MAAM;YA2DvF,CAAA;AAGD,eAAO,MAAM,UAAU;eAA2B,MAAM;YAsCvD,CAAA;AAGD,eAAO,MAAM,UAAU;mBAA+B,MAAM;YAqB3D,CAAA;AAGD,eAAO,MAAM,WAAW,yOAqBvB,CAAA;AAGD,eAAO,MAAM,YAAY,6NAqDxB,CAAA;AAGD,eAAO,MAAM,WAAW,6NA+BvB,CAAA;AAGD,eAAO,MAAM,SAAS;aAAyB,OAAO;YAYrD,CAAA;AAGD,eAAO,MAAM,YAAY,6NAUxB,CAAA;AAGD,eAAO,MAAM,YAAY;eAA2B,MAAM;YAwBzD,CAAA"}

package/dist/hooks/useOrdifyConfig.d.ts

@@ -15,6 +15,7 @@ export declare function useOrdifyConfig(config: OrdifyConfig): {
     showHeader: boolean;
     buttonText: string | undefined;
     chatName: string | undefined;
+    primaryColor: string | undefined;
     onMessage: ((message: import('../types').Message) => void) | undefined;
     onError: ((error: Error) => void) | undefined;
     onClose: (() => void) | undefined;

package/dist/hooks/useOrdifyConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useOrdifyConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useOrdifyConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGtC,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;EAsCnD"}
+{"version":3,"file":"useOrdifyConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useOrdifyConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAGtC,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY;;;;;;;;;;;;;;;;;;;;;;EAuCnD"}