@qr-platform/qr-code.js 0.8.17 → 0.8.19

package/.github/workflows/gh-pages.yml

@@ -0,0 +1,50 @@
+name: Deploy Documentation with GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.github/workflows/publish.yml

@@ -4,15 +4,35 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch: # Enables manual triggering
 
 jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
-      - name: Publish to npm
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Check if version exists
+        id: check_version
         run: |
-          npm config set //registry.npmjs.org/:_authToken ${{ secrets.NPM_TOKEN }}
-          npm publish --access public
+          VERSION=$(node -p "require('./package.json').version")
+          if npm view ${GITHUB_REPOSITORY#*/}@${VERSION} version >/dev/null 2>&1; then
+            echo "Version ${VERSION} already exists on npm, skipping publish."
+            echo "skip_publish=true" >> $GITHUB_OUTPUT
+          else
+            echo "Version ${VERSION} does not exist, proceeding with publish."
+            echo "skip_publish=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Publish to npm
+        if: steps.check_version.outputs.skip_publish == 'false'
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,10 +1,15 @@
 # @qr-platform/qr-code-js
 
+## 0.8.19
+
+### Patch Changes
+
+- 5cfd829: Readme, Documentation, License updates
+
 ## 0.8.17
 
 ### Patch Changes
 
-- 809309c: Domain validation from token
 - a3d5390: Update to Validation and Node library
 
 ## 0.8.16

package/README.md

@@ -1,15 +1,14 @@
-# QRCode.js - @qr-platform/qr-code.js
+# QRCode.js - Simple, Beautiful, Reliable
 
 [![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
+## 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.
+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://www.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 -->
+<!-- ![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.
@@ -26,19 +25,33 @@ QRCode.js is a professional JavaScript/TypeScript library for creating customize
 
 ## 🚀 Installation
 
+
+#### NPM ⤵️
+
 ```bash
-# Using npm
 npm install @qr-platform/qr-code.js
+```
 
-# Using yarn
+#### YARN ⤵️
+```bash
 yarn add @qr-platform/qr-code.js
-
-# Using pnpm
+```
+#### PNPM ⤵️
+```bash
 pnpm add @qr-platform/qr-code.js
 ```
 
 ## 💡 Basic Usage
 
+```typescript
+import { QRCodeJs } from '@qr-platform/qr-code.js';
+
+const qrCode = new QRCodeJs({ data: 'https://example.com' });
+qrCode.append(document.getElementById('qr-container'));
+
+```
+#### or
+
 ```typescript
 import { QRCodeJs, Options } from '@qr-platform/qr-code.js';
 
@@ -91,14 +104,14 @@ qrCode.serialize().then(svgString => {
 | `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).*
+#### For a full list of options, see the [API Reference Guide](https://qr-platform.github.io/qr-code.js/docs/api-reference-guide.html).
 
 ## 🎨 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.
+* #### [Basic Examples](https://qr-platform.github.io/qr-code.js/docs/examples.html) Get started with common use cases.
+* #### [Advanced Examples](https://qr-platform.github.io/qr-code.js/docs/advanced-examples.html) Dive deep into customization possibilities. 
 
 ## 🖥️ Node.js Usage
 
@@ -128,7 +141,17 @@ qrCode.serialize().then(svgString => {
 **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 activation (if needed) persists only in memory per session. See [License Management](https://qr-platform.github.io/qr-code.js/docs/license-management.html) for details.
+*   **Peer Dependencies:** You must install the required `peerDependencies` for Node.js functionality. 
+  
+    Install automatically using npx:
+     ```bash 
+     npx i-peers
+    ```
+    Install manually using npm:
+    ````bash
+     npm i @xmldom/xmldom @undecaf/zbar-wasm image-size jose jimp @resvg/resvg-js file-type
+     ````
 
 ## 🔑 License Management (Free vs. Premium)
 
@@ -172,17 +195,17 @@ const qrPremium = new QRCodeJs({
 });
 ```
 
-*For full details on activation, persistence, configuration, and backend implementation, see the [License Management Guide](./docs/license-management.md#start).*
+##### For full details on activation, persistence, configuration, and backend implementation, see the [License Management Guide](https://qr-platform.github.io/qr-code.js/docs/license-management.html).
 
 ## 📚 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.
+*   ##### [Usage Guide](https://qr-platform.github.io/qr-code.js/docs/usage-guide.html) Comprehensive guide covering all options.
+*   ##### [API Reference](https://qr-platform.github.io/qr-code.js/docs/api-reference-guide.html) Detailed reference for all options, methods, and enums.
+*   ##### [TypeScript Definitions](https://qr-platform.github.io/qr-code.js/docs/typescript-types-definitions.html) Full TypeScript type definitions.
+*   ##### [Basic Examples](https://qr-platform.github.io/qr-code.js/docs/examples.html) Simple examples to get started.
+*   ##### [Advanced Examples](https://qr-platform.github.io/qr-code.js/docs/advanced-examples.html) Complex customization examples.
+*   ##### [License Management](https://qr-platform.github.io/qr-code.js/docs/license-management.html) 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).
+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 - see the [LICENSE](https://qr-platform.github.io/qr-code.js/LICENSE.md) file for details. Premium features require a separate commercial license from [QR-Platform](https://www.qr-platform.com).

package/docs/documentation.md

@@ -827,6 +827,17 @@ qrCode.serialize().then(svgString => {
 ### Key Differences & Considerations
 
 - **Import Path**: Use `import { QRCodeJs } from '@qr-platform/qr-code.js/node';`.
+
+- **Peer Dependencies:** You must install the required `peerDependencies` for Node.js functionality.
+  
+  Install automatically using npx:
+  ```bash
+  npx i-peers @qr-platform/qr-code.js
+  ```
+  Install manually using npm:
+  ```bash
+  npm i @xmldom/xmldom @undecaf/zbar-wasm image-size jose jimp @resvg/resvg-js file-type
+  ```
 - **No Canvas/Download**: Methods relying on browser APIs like `append()`, `download()`, or internal canvas generation are not available or behave differently in the Node.js version.
 - **License Management**: Use the static methods described in the [License Management](#license-management) section.
 - **Border Branding**: Similar to the browser version, Node.js will add "QR-Platform" branding to borders in the free version. To remove this, you'll need to activate a license.

package/docs/usage-guide.md

@@ -410,6 +410,17 @@ To use QRCode.js in a Node.js environment:
 - **Key considerations**:
   - Use `serialize()` to obtain the SVG as a string for further processing.
 
+  - **Peer Dependencies:** You must install the required `peerDependencies` for Node.js functionality.
+    
+    Install automatically using npx:
+    ```bash
+    npx i-peers @qr-platform/qr-code.js
+    ```
+    Install manually using npm:
+    ```bash
+    npm i @xmldom/xmldom @undecaf/zbar-wasm image-size jose jimp @resvg/resvg-js file-type
+    ```
+
 ---
 <a id="license-management"></a>
 ### License Management