@qr-platform/qr-code.js 0.8.17

package/.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Publish to npm
+        run: |
+          npm config set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
+          npm publish --access public

package/CHANGELOG.md

@@ -0,0 +1,233 @@
+# @qr-platform/qr-code-js
+
+## 0.8.17
+
+### Patch Changes
+
+- 809309c: Domain validation from token
+- a3d5390: Update to Validation and Node library
+
+## 0.8.16
+
+### Patch Changes
+
+- 4fe192a: feat: added node validator without jimp and sharp
+
+## 0.8.15
+
+### Patch Changes
+
+- 371fc30: import Position type
+
+## 0.8.14
+
+### Patch Changes
+
+- 8c5c33d: changesets
+
+## 0.8.13
+
+### Patch Changes
+
+- 614288c: fix path
+
+## 0.8.12
+
+### Patch Changes
+
+- 51916e2: validation refactoring
+
+## 0.8.11
+
+### Patch Changes
+
+- 7d722f4: zlib - make only one attempt
+
+## 0.8.10
+
+### Patch Changes
+
+- de43501: change zlib path
+
+## 0.8.9
+
+### Patch Changes
+
+- 6484ce8: new version of zbar library (x2 zoom)
+
+## 0.8.8
+
+### Patch Changes
+
+- 2be1fa6: fix zbar path
+
+## 0.8.7
+
+### Patch Changes
+
+- bd51c06: add zbar validation
+
+## 0.8.6
+
+### Patch Changes
+
+- ca33ed1: new validation version
+
+## 0.8.5
+
+### Patch Changes
+
+- a7e1d58: fix scan-validator
+
+## 0.8.4
+
+### Patch Changes
+
+- ce15b6f: fix scan-validator
+
+## 0.8.3
+
+### Patch Changes
+
+- 61fe588: fix scan validator
+
+## 0.8.2
+
+### Patch Changes
+
+- f456d90: fix scan validator
+
+## 0.8.1
+
+### Patch Changes
+
+- 84db585: Node Export Option Changed to QRCodeJsOptions
+- 954ccad: Fixed scan validator
+
+## 0.8.0
+
+### Minor Changes
+
+- 6f87620: Added QR scanning validators
+
+## 0.7.5
+
+### Patch Changes
+
+- c6ea22c: Border option for inner cutout scale and offset added
+- ae53fde: Border outter position behind qr code
+
+## 0.7.4
+
+### Patch Changes
+
+- 6f30bd9: Validation QR Code JS Options
+- 6f30bd9: Exports Lib Name Changed
+
+## 0.7.3
+
+### Patch Changes
+
+- 20a46bc: Outter border qr offset added
+
+## 0.7.2
+
+### Patch Changes
+
+- bdad351: Round border text fixes for different combinations
+
+## 0.7.1
+
+### Patch Changes
+
+- 7ff7a0a: Removed round and replaced with radius string only
+
+## 0.7.0
+
+### Minor Changes
+
+- aa530a4: Rename disableCurve to curveDisabled
+
+## 0.6.0
+
+### Minor Changes
+
+- 800081e: radius should be of type number of percentage
+
+## 0.5.0
+
+### Minor Changes
+
+- ef2af08: fix reexport BorderOptions and Position interface and type
+
+## 0.4.0
+
+### Minor Changes
+
+- 23ac2fd: fix types
+
+## 0.3.0
+
+### Minor Changes
+
+- 527180a: fix: change type for options
+
+## 0.2.0
+
+### Minor Changes
+
+- 82bb86c: Disable for DecorationOption is optional
+
+## 0.1.0
+
+### Minor Changes
+
+- 4b53fb0: Add export BorderOptions
+
+## 0.0.13
+
+### Patch Changes
+
+- 0d64e48: Export Position type from QRBorderPlugin
+
+## 0.0.12
+
+### Patch Changes
+
+- a426d0b: Fix for default background red, changed to #ffff
+
+## 0.0.11
+
+### Patch Changes
+
+- 69696df: Outter and Inner decorative borders improvements
+
+## 0.0.10
+
+### Patch Changes
+
+- 75660f1: Updated package json to export for node
+
+## 0.0.9
+
+### Patch Changes
+
+- 2e45431: update to export name
+
+## 0.0.8
+
+### Patch Changes
+
+- e28c564: Package json update to export types, node and browser files
+
+## 0.0.7
+
+### Patch Changes
+
+- d833eb4: Another Test Publish
+
+## 0.0.6
+
+### Patch Changes
+
+- 3a68929: Test release new version (no changes)

package/LICENSE.md

@@ -0,0 +1,77 @@
+# QRCode.js Library - License Terms and Conditions
+
+**Effective Date:** April 13, 2025
+
+**IMPORTANT:** PLEASE READ THESE TERMS AND CONDITIONS CAREFULLY BEFORE USING THE QRCode.js LIBRARY. BY DOWNLOADING, INSTALLING, OR USING THE QRCode.js LIBRARY ARTIFACT (THE "SOFTWARE"), YOU ("USER") AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS, DO NOT USE THE SOFTWARE.
+
+This Software is licensed, not sold, by QR-Platform ("Licensor") for use only under the terms of this license. The source code for the Software is proprietary, confidential, and is **not** provided or licensed under this agreement. Licensor reserves all rights not expressly granted to User.
+
+## 1. License Grant
+
+Subject to the terms and conditions of this Agreement, Licensor grants User a limited, non-exclusive, non-transferable, non-sublicensable, revocable license to:
+
+* **a) Free Tier Usage:** Install and use the Software solely as integrated into User's applications ("User Applications") **provided that User only utilizes the Free Features** of the Software. "Free Features" include all functionalities of the Software *except* for the "Premium Features" defined below.
+* **b) Premium Tier Usage:** Use the "Premium Features" of the Software, **only if and for the duration** User has purchased and holds a valid, separate **Commercial License** from Licensor. The terms of the Commercial License will supplement this agreement and specifically govern the use of Premium Features.
+
+## 2. Premium Features
+
+The following functionalities of the Software are currently designated as "Premium Features" and require a valid **Commercial License** for any use (including development, testing, and production):
+
+1.  **Borders (`borderOptions`)**: All options and functionalities related to creating and customizing borders around the QR code.
+2.  **Scan Validation (`validateScanning` method)**: The functionality provided by the `validateScanning()` method, which may utilize canvas-based analysis, to verify QR code scannability and decode its content.
+
+**Using Premium Features without a valid Commercial License is strictly prohibited** and constitutes a breach of this Agreement. Attempting to use these features without a valid license may result in limited functionality, watermarking, exceptions, or error messages indicating the license requirement.
+
+**Obtaining a Commercial License:**
+To purchase a Commercial License, please visit: **[www.qr-platform.com/qr-code-js#license](https://www.qr-platform.com/qr-code-js#license)**
+Or contact us at: **contact@qr-platform.com**
+
+**Reservation of Rights to Designate Premium Features:**
+**Licensor reserves the right, at its sole discretion, to designate additional features or functionalities of the Software as 'Premium Features' at any time and without prior notice. Any features so designated will subsequently require a valid Commercial License for their use under the terms of this Agreement and the applicable Commercial License Agreement.**
+
+## 3. Restrictions on Use
+
+User agrees **not** to:
+* a) Reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code or underlying algorithms of the Software.
+* b) Modify, adapt, translate, or create derivative works based on the Software artifact itself.
+* c) Rent, lease, loan, sublicense, sell, or distribute the Software as a standalone product. User MAY distribute the Software solely when integrated as an inseparable part of User Applications, subject to the terms herein.
+* d) Remove, alter, or obscure any copyright, trademark, or other proprietary notices on or in the Software.
+* e) Use the Premium Features without a valid Commercial License.
+* f) Use the Software for any illegal purpose or in violation of any applicable laws.
+
+## 4. Support
+
+* **Free Tier:** Users utilizing only the Free Features may seek support via community channels (e.g., GitHub Issues) on a best-effort basis. Licensor provides no guaranteed response time or resolution for the Free Tier.
+* **Premium Tier:** Users holding a valid Commercial License are entitled to priority support as specified in their Commercial License Agreement.
+
+## 5. Intellectual Property
+
+The Software is protected by copyright and other intellectual property laws and treaties. Licensor retains all right, title, and interest in and to the Software, including all copyrights, patents, trade secrets, trademarks, and other intellectual property rights. This license grants User limited rights to use the Software artifact and does not transfer any ownership rights.
+
+## 6. Disclaimer of Warranty
+
+THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, LICENSOR DISCLAIMS ALL WARRANTIES AND CONDITIONS, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT. LICENSOR DOES NOT WARRANT THAT THE SOFTWARE WILL MEET USER'S REQUIREMENTS, OPERATE WITHOUT INTERRUPTION, OR BE ERROR-FREE.
+
+## 7. Limitation of Liability
+
+TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL LICENSOR OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, CONSEQUENTIAL, PUNITIVE, OR EXEMPLARY DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL LICENSOR'S TOTAL LIABILITY TO USER FOR ALL DAMAGES EXCEED THE AMOUNT PAID BY USER FOR A COMMERCIAL LICENSE TO THE SOFTWARE, IF ANY, OR USD $50.00, WHICHEVER IS GREATER.
+
+## 8. Term and Termination
+
+This License Agreement is effective until terminated. User's rights under this license will terminate automatically without notice from Licensor if User fails to comply with any term(s) of this license. Upon termination, User shall cease all use of the Software and destroy all copies, full or partial, of the Software artifact. Sections 3, 5, 6, 7, 9, and 11 shall survive any termination.
+
+## 9. Governing Law
+
+This License Agreement shall be governed by and construed in accordance with the laws of **[Your State, e.g., the State of California]**, USA, without regard to its conflict of law principles. User agrees that any disputes arising under this Agreement shall be subject to the exclusive jurisdiction of the state and federal courts located in **[Your County and State, e.g., Santa Clara County, California]**.
+
+## 10. Entire Agreement
+
+This Agreement, together with the terms of any valid Commercial License obtained by User (if applicable), constitutes the entire agreement between User and Licensor relating to the Software and supersedes all prior or contemporaneous understandings regarding such subject matter. No amendment to or modification of this Agreement will be binding unless in writing and signed by Licensor.
+
+## 11. Contact Information
+
+For questions regarding this license or to inquire about Commercial Licensing, please contact QR-Platform at: **contact@qr-platform.com** or visit **[www.qr-platform.com/qr-code-js#license](https://www.qr-platform.com/qr-code-js#license)**.
+
+---
+
+**Legal Disclaimer:** This license template is provided for informational purposes only and does not constitute legal advice. QR-Platform strongly recommends consulting with a qualified legal professional to ensure this license agreement is suitable for your specific needs and complies with all applicable laws and regulations.

package/README.md

@@ -0,0 +1,188 @@
+# QRCode.js - @qr-platform/qr-code.js
+
+[![npm version](https://badge.fury.io/js/%40qr-platform%2Fqr-code.js.svg)](https://badge.fury.io/js/%40qr-platform%2Fqr-code.js)
+
+<!-- Add other badges like build status, coverage, etc. if available -->
+
+## Simple, Beautiful, Reliable
+##### Create Beautiful, Reliable QR Codes with Ease
+
+QRCode.js is a professional JavaScript/TypeScript library for creating customized QR codes, offering a blend of simplicity and sophistication. With versatile styling options—dot shapes, colors, gradients, embedded images, borders, and text—it enables you to design unique, visually appealing QR codes that work flawlessly with standard scanners. QRCode.js is part of [QR-Platform](https://qr-platform.com): All-in-One QR Codes Management Solution.
+
+![QR Code Styling Example](https://raw.githubusercontent.com/qr-platform/qr-code.js/main/src/assets/qr-styling.png) <!-- Placeholder: Replace with an actual representative image URL if available -->
+
+## ✨ Features
+*   **Core QR Code Generation**: Encode any text, URL, or data.
+*   **Highly Customizable:** Control dot shapes, colors, sizes, corner styles, and background.
+*   **Gradients:** Apply linear or radial gradients to dots, corners, and backgrounds.
+*   **Image Embedding:** Embed logos or other images in the center, as an overlay, or as a background.
+*   **Borders (Free & Premium):** Add basic borders (with branding in free version) or advanced, customizable borders with text/images (Premium).
+*   **Flexible Output:** Generate QR codes as SVG elements in the browser or SVG strings in Node.js.
+*   **Download Options:** Download QR codes as SVG, PNG, JPEG, or WEBP.
+*   **TypeScript Support:** Fully typed for a better development experience.
+*   **Node.js Compatible:** Works seamlessly in server-side environments.
+*   **Responsive:** Option to make SVG output responsive to container size.
+*   **Scan Validation (Premium):** Verify the scannability of generated QR codes.
+
+## 🚀 Installation
+
+```bash
+# Using npm
+npm install @qr-platform/qr-code.js
+
+# Using yarn
+yarn add @qr-platform/qr-code.js
+
+# Using pnpm
+pnpm add @qr-platform/qr-code.js
+```
+
+## 💡 Basic Usage
+
+```typescript
+import { QRCodeJs, Options } from '@qr-platform/qr-code.js';
+
+// 1. Define options (only 'data' is required)
+const options: Options = {
+  data: 'https://example.com',
+  dotsOptions: {
+    color: '#007bff', // Blue dots
+    type: 'rounded'   // Use rounded dots
+  },
+  backgroundOptions: {
+    color: '#ffffff' // White background
+  }
+};
+
+// 2. Create QR Code instance
+const qrCode = new QRCodeJs(options);
+
+// 3. Append to a container element (in browser)
+const container = document.getElementById('qr-container');
+if (container) {
+  qrCode.append(container);
+}
+
+// Or get SVG string (Browser or Node.js)
+qrCode.serialize().then(svgString => {
+  if (svgString) {
+    console.log('QR Code SVG:', svgString);
+    // In Node.js, you might save this string to a file
+    // require('fs').writeFileSync('qrcode.svg', svgString);
+  }
+});
+```
+
+## ⚙️ Key Options Overview
+
+| Option                 | Description                                      | Example Value        |
+| :--------------------- | :----------------------------------------------- | :------------------- |
+| `data`                 | **Required.** The content to encode.             | `'Your URL here'`    |
+| `shape`                | Overall shape (`'square'` or `'circle'`).        | `'circle'`           |
+| `margin`               | Quiet zone around the QR code (pixels).          | `10`                 |
+| `qrOptions.errorCorrectionLevel` | Error correction (`'L'`, `'M'`, `'Q'`, `'H'`). | `'H'`                |
+| `dotsOptions.type`     | Shape of the data dots (e.g., `rounded`, `dot`). | `'rounded'`          |
+| `dotsOptions.color`    | Color of the data dots.                          | `'#ff5733'`          |
+| `dotsOptions.gradient` | Gradient for dots (see [Gradients](#gradients)). | `{ type: 'linear', ... }` |
+| `cornersSquareOptions` | Style for the large corner squares.              | `{ type: 'dot', color: '#00ff00' }` |
+| `cornersDotOptions`    | Style for the small dots inside corners.         | `{ type: 'square', color: '#ffffff' }` |
+| `backgroundOptions`    | Background style (color, roundness, gradient).   | `{ color: '#f0f0f0', round: 0.2 }` |
+| `image`                | URL/Buffer/Blob of image to embed.               | `'logo.png'`         |
+| `imageOptions`         | Options for the embedded image (size, margin).   | `{ imageSize: 0.3, margin: 2 }` |
+| `borderOptions`        | **Premium.** Options for decorative borders.     | `{ hasBorder: true, thickness: 20, ... }` |
+
+*For a full list of options, see the [API Reference Guide](./docs/api-reference-guide.md#start).*
+
+## 🎨 Examples
+
+Explore various configurations:
+
+*   **[Basic Examples](./docs/examples.md#start):** Get started with common use cases.
+*   **[Advanced Examples](./docs/advanced-examples.md#start):** Dive deep into customization possibilities.
+
+## 🖥️ Node.js Usage
+
+QRCode.js works in Node.js for server-side generation.
+
+```typescript
+import { QRCodeJs, Options } from '@qr-platform/qr-code.js/node'; // Note the '/node' import
+import fs from 'fs';
+
+const options: Options = {
+  data: 'https://example.com/from-node',
+  dotsOptions: {
+    color: '#8A2BE2' // BlueViolet
+  }
+};
+
+const qrCode = new QRCodeJs(options);
+
+qrCode.serialize().then(svgString => {
+  if (svgString) {
+    fs.writeFileSync('qrcode-node.svg', svgString);
+    console.log('QR Code saved to qrcode-node.svg');
+  }
+});
+```
+
+**Key Differences:**
+*   Import from `@qr-platform/qr-code.js/node`.
+*   Methods requiring a DOM like `append()` or `download()` are not available. Use `serialize()` to get the SVG string.
+*   License activation (if needed) persists only in memory per session. See [License Management](./docs/license-management.md#start).
+
+## 🔑 License Management (Free vs. Premium)
+
+QRCode.js offers both free and premium features.
+
+*   **Free Version:**
+    *   All core generation and styling features (dots, corners, background, gradients, image embedding).
+    *   Basic border styling (`borderOptions.hasBorder`, `thickness`, `color`, `radius`).
+    *   **Limitation:** Borders created in the free version will automatically display "QR-Platform" branding text in the bottom border. This cannot be removed or customized without a license.
+
+*   **Premium Version (Requires License):**
+    *   **Advanced Borders:** No branding, custom text/images on any side, inner/outer borders, full styling control.
+    *   **Scan Validation:** Access to the `validateScanning()` method.
+
+**Activating a License:**
+
+```typescript
+// Activate BEFORE creating QRCodeJs instances
+// Using a license key (fetches token from backend)
+await QRCodeJs.license('YOUR-LICENSE-KEY');
+
+// Or using a pre-fetched JWT token
+await QRCodeJs.token('YOUR-JWT-TOKEN');
+
+// Check license status
+const licenseDetails = QRCodeJs.getLicenseDetails();
+if (licenseDetails) {
+  console.log('License active. Plan:', licenseDetails.plan);
+}
+
+// Now create instances with premium features enabled
+const qrPremium = new QRCodeJs({
+  data: 'Premium QR Code',
+  borderOptions: {
+    hasBorder: true,
+    thickness: 30,
+    decorations: {
+      bottom: { enableText: true, value: 'My Custom Text' } // No branding!
+    }
+  }
+});
+```
+
+*For full details on activation, persistence, configuration, and backend implementation, see the [License Management Guide](./docs/license-management.md#start).*
+
+## 📚 Documentation
+
+*   **[Usage Guide](./docs/usage-guide.md#start):** Comprehensive guide covering all options.
+*   **[API Reference](./docs/api-reference-guide.md#start):** Detailed reference for all options, methods, and enums.
+*   **[TypeScript Definitions](./docs/typescript-types-definitions.md#start):** Full TypeScript type definitions.
+*   **[Basic Examples](./docs/examples.md#start):** Simple examples to get started.
+*   **[Advanced Examples](./docs/advanced-examples.md#start):** Complex customization examples.
+*   **[License Management](./docs/license-management.md#start):** Details on free vs. premium features and activation.
+
+## 📜 License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. Premium features require a separate commercial license from [QR-Platform](https://qr-platform.com).