@alfredo-ai/leads-widget 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Alfredo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,162 @@
+# @alfredo/leads-widget
+
+Embeddable leads widget with optional SMS validation, designed for Alfredo and PropData integration. Built with React, Material UI, Redux, and TailwindCSS.
+
+## Features
+
+- Multi-step lead form (location, characteristics, personal data, optional SMS validation)
+- Multi-language support (Portuguese, English, Spanish)
+- Google Maps integration for location selection
+- Price interval / estimation display
+- Optional SMS verification flow
+- Theming via `primaryColor` and `backgroundColor`
+
+## Installation
+
+### Via npm
+
+```bash
+npm install @alfredo/leads-widget
+```
+
+### Via script tag (CDN)
+
+No install required. Load the UMD bundle directly (see [Script tag usage](#script-tag-umd) below).
+
+---
+
+## Usage
+
+### Script tag (UMD)
+
+1. Add a container element where the widget should render:
+
+```html
+<div id="leads-widget-root"></div>
+```
+
+2. Load the widget script and styles:
+
+```html
+<script src="https://unpkg.com/@alfredo/leads-widget/dist/widget.umd.cjs"></script>
+<link rel="stylesheet" href="https://unpkg.com/@alfredo/leads-widget/dist/style.css" />
+```
+
+3. Initialize the widget:
+
+```html
+<script>
+  window.initLeadsWidget({
+    token: "YOUR_ALFREDO_LEADS_TOKEN",
+    container: "leads-widget-root",
+    origin: "pt",
+  });
+</script>
+```
+
+### NPM / ESM (React or any bundler)
+
+Import the package so that `initLeadsWidget` is attached to `window`, then call it once the container element is in the DOM:
+
+```js
+import "@alfredo/leads-widget";
+import "@alfredo/leads-widget/style.css";
+
+window.initLeadsWidget({
+  token: "YOUR_ALFREDO_LEADS_TOKEN",
+  container: "leads-widget-root",
+  origin: "pt",
+});
+```
+
+Example in a React component:
+
+```jsx
+import { useEffect } from "react";
+import "@alfredo/leads-widget";
+import "@alfredo/leads-widget/style.css";
+
+function LeadsWidget() {
+  useEffect(() => {
+    window.initLeadsWidget({
+      token: "YOUR_ALFREDO_LEADS_TOKEN",
+      container: "leads-widget-root",
+      origin: "pt",
+    });
+  }, []);
+
+  return <div id="leads-widget-root" />;
+}
+```
+
+---
+
+## Configuration options
+
+| Option            | Type    | Default     | Description                                       |
+| ----------------- | ------- | ----------- | ------------------------------------------------- |
+| `container`       | string  | `"root"`    | DOM id of the element where the widget mounts.    |
+| `origin`          | string  | `"pt"`      | Origin/locale key (`"pt"`, `"es"`, `"gb"`).       |
+| `userID`          | string  | `null`      | Optional user identifier.                         |
+| `lang`            | string  | `null`      | Preferred language (`pt`, `en`, `es`).            |
+| `token`           | string  | -           | Alfredo leads API token.                          |
+| `showHeader`      | boolean | `true`      | Whether to show the widget header.                |
+| `primaryColor`    | string  | `"#009de0"` | Primary theme color (hex).                        |
+| `backgroundColor` | string  | `"#f7f7f7"` | Background color (hex).                           |
+
+---
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 18
+
+### Commands
+
+```bash
+# Install dependencies
+npm install
+
+# Start dev server (with hot reload)
+npm run dev
+
+# Production build (outputs to dist/)
+npm run build
+
+# Preview production build locally
+npm run preview
+```
+
+### Test the built widget locally
+
+```bash
+npm run build
+node serve
+```
+
+Then open http://localhost:3002 to see the widget running from the UMD build.
+
+---
+
+## Publishing to npm
+
+1. Log in to npm (if not already):
+
+```bash
+npm login
+```
+
+2. Publish (scoped packages need `--access public`):
+
+```bash
+npm publish --access public
+```
+
+The `prepublishOnly` script automatically runs `npm run build` before publishing.
+
+---
+
+## License
+
+MIT. See [LICENSE](LICENSE) for details.