@qr-platform/qr-code.js 0.10.7 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @qr-platform/qr-code-js
 
+## 0.11.0
+
+### Minor Changes
+
+- Release a minor version with new features.
+
 ## 0.10.7
 
 ### Patch Changes
@@ -193,7 +199,7 @@
 
 ### Patch Changes
 
-- 20a46bc: Outter border qr offset added
+- 20a46bc: Outer border qr offset added
 
 ## 0.7.2
 
@@ -265,7 +271,7 @@
 
 ### Patch Changes
 
-- 69696df: Outter and Inner decorative borders improvements
+- 69696df: Outer and Inner decorative borders improvements
 
 ## 0.0.10
 

package/docs/api-reference-guide.md

@@ -109,8 +109,20 @@ qrCode.append(document.getElementById('qr-container'));
 | `useImage`          | `imageUrl: string \| DataURL, overrideOpts?: MethodOverrideOptions`            | Initiates a builder pattern pre-configured with an image URL. If `overrideOpts.override` is `true`, this image will take precedence over any image set in the final `.options()` call or by other non-overriding builder methods. Returns `QRCodeBuilder`. |
 | `useData`           | `data: string, overrideOpts?: MethodOverrideOptions`                           | Applies a data string to the current builder configuration. If `overrideOpts.override` is `true`, this data will take precedence over data provided in the final `.options()` call or by other non-overriding builder methods. Returns `QRCodeBuilder`. |
 | `useOptions`        | `options: RecursivePartial<Options>, overrideOpts?: MethodOverrideOptions`     | Applies a partial options object to the current builder configuration. If `overrideOpts.override` is `true`, these options take higher precedence over options provided in the final `.options()` call or by other non-overriding builder methods for the properties they cover. Returns `QRCodeBuilder`. |
-| `useSettings`       | `settings: SettingsOptions`                                                | Applies a comprehensive `SettingsOptions` object as a new baseline for the builder chain. This will **reset** any configurations previously applied to *that builder instance* via methods like `useTemplate()`, `useStyle()`, `useData()`, `useOptions()`, etc. Subsequent builder methods will modify this new baseline. Returns `QRCodeBuilder`. |
-| `validateScanning`  | `validatorId?: string, debug?: boolean`                                    | **(Premium method)** Validates that the QR code is scannable. Returns `Promise<ScanValidatorResponse>`. |
+| `useSettings`       | `settings: SettingsOptions` | Applies a comprehensive `SettingsOptions` object as a new baseline for the builder chain. This will **reset** any configurations previously applied to *that builder instance* via methods like `useTemplate()`, `useStyle()`, `useData()`, `useOptions()`, etc. Subsequent builder methods will modify this new baseline. Returns `QRCodeBuilder`. |
+| `useId`             | `id: string` | Assigns an identifier to the QR code instance within the builder chain. Returns `QRCodeBuilder`. |
+| `useName`           | `name: string` | Assigns a name to the QR code instance within the builder chain. Returns `QRCodeBuilder`. |
+| `useDescription`    | `description: string` | Assigns a description to the QR code instance within the builder chain. Returns `QRCodeBuilder`. |
+| `useMetadata`       | `metadata: Record<string, any>` | Attaches custom metadata to the QR code instance within the builder chain. Returns `QRCodeBuilder`. |
+| `validateScanning`  | `validatorId?: string, debug?: boolean` | **(Premium method)** Validates that the QR code is scannable. Returns `Promise<ScanValidatorResponse>`. |
+| `getTemplates`      |  | Returns helper functions for looking up predefined templates, styles, text, and borders. |
+| `initializeIfNeeded` |  | Initializes the license manager if needed (usually called automatically by `.license()`). Returns `Promise<boolean>`. |
+| `getLicenseDetails` |  | Returns decoded license information if a license is active. |
+| `license`           | `licenseKey: string` | Activates a license using a license key. Returns `Promise<ValidationResult>`. |
+| `token`             | `token: string | null` | Activates a license using a pre-fetched token. Returns `Promise<ValidationResult>`. |
+| `configureLicenseFetcher` | `fetcher: (licenseKey: string) => Promise<string>` | Sets a custom function for fetching license tokens. |
+| `setLicenseUrl`     | `url: string` | Sets the URL endpoint for license validation. Returns `typeof QRCodeJs`. |
+| `validateImageData` | `imageData: ImageDataLike` | **(Node.js)** Validate scannability from raw image data. Returns `Promise<ScanValidatorResponse>`. |
 
 ---
 

package/docs/documentation.md

@@ -1078,8 +1078,8 @@ When using the basic border features in the free version, the library will autom
 ### Initialization
 
 - **Purpose**: Sets up the license manager
-- **Behavior**: Initializes automatically when you first attempt activation or check the status
-- **Manual Method**: `QRCodeJs.initializeIfNeeded()`
+- **Behavior**: Initializes automatically when you call `.license()` (or otherwise attempt activation) or check the status
+- **Manual Method**: `QRCodeJs.initializeIfNeeded()` (rarely needed because `.license()` runs it automatically)
 - **Example**:
   ```typescript
   async function initializeOnLoad() {
@@ -1700,6 +1700,23 @@ qrCode.validateScanning(
 ): Promise<ScanValidatorResponse>
 ```
 
+#### Metadata Methods
+
+These helper methods allow attaching or retrieving metadata on a QR code instance.
+
+```typescript
+qrCode.setId(id?: string): this
+qrCode.setName(name?: string): this
+qrCode.setDescription(description?: string): this
+qrCode.setMetadata(metadata?: Record<string, any>): this
+
+qrCode.getId(): string | undefined
+qrCode.getName(): string | undefined
+qrCode.getDescription(): string | undefined
+qrCode.getMetadata(): Record<string, any> | undefined
+qrCode.getSettings(): SettingsOptions & { options: Options }
+```
+
 ### Static Methods
 
 These methods are called directly on the `QRCodeJs` class (e.g., `QRCodeJs.setTemplate()`).
@@ -1708,7 +1725,7 @@ These methods are called directly on the `QRCodeJs` class (e.g., `QRCodeJs.setTe
 
 #### `initializeIfNeeded()`
 
-Initializes the license manager if needed.
+Initializes the license manager if needed. Typically this runs automatically when calling `.license()`, but you can call it manually in unusual scenarios.
 
 ```typescript
 QRCodeJs.initializeIfNeeded(): Promise<boolean>

package/docs/license-management.md

@@ -44,8 +44,8 @@ When using the basic border features in the free version, the library will autom
 ### Initialization
 
 - **Purpose**: Sets up the license manager
-- **Behavior**: Initializes automatically when you first attempt activation or check the status
-- **Manual Method**: `QRCodeJs.initializeIfNeeded()`
+- **Behavior**: Initializes automatically when you call `.license()` (or otherwise attempt activation) or check the status
+- **Manual Method**: `QRCodeJs.initializeIfNeeded()` (rarely needed because `.license()` runs it automatically)
 - **Example**:
   ```typescript
   async function initializeOnLoad() {
@@ -413,7 +413,7 @@ async function activateWithTokenNode(token) {
 
 #### `initializeIfNeeded()`
 
-- **Purpose**: Initialize license manager if needed
+- **Purpose**: Initialize the license manager if needed (normally handled automatically by `.license()`)
 - **Type**: `function(): Promise<boolean>`
 - **Returns**: Promise resolving to license status
 

package/docs/usage-guide.md

@@ -600,15 +600,18 @@ const qrCode = QRCodeJs.useTemplate('dots')       // Base: dots template (e.g.,
 qrCode.append(document.getElementById('builder-example-container'));
 
 
-### Builder Pattern Methods (`useStyle`, `useBorder`, `useImage`, `useData`, `useOptions`, `useSettings`)
+### Builder Pattern Methods (`useTemplate`, `useStyle`, `useBorder`, `useImage`, `useData`, `useOptions`, `useSettings`)
 
-These methods are called on `QRCodeJs` to initiate a builder chain (e.g., `QRCodeJs.useStyle(...)`) or on an existing `QRCodeBuilder` instance (e.g., `builder.useStyle(...)`).
+These methods are called on `QRCodeJs` to initiate a builder chain (e.g., `QRCodeJs.useTemplate(...)`) or on an existing `QRCodeBuilder` instance (e.g., `builder.useStyle(...)`).
 
+- **`useTemplate(templateNameOrOptions)` / `useTemplateId(templateId)`**: Start the builder with a predefined template or template ID.
 - **`useStyle(styleNameOrOptions)` / `useStyleId(styleId)`**: Applies a style.
 - **`useBorder(borderNameOrOptions)` / `useBorderId(borderId)`**: Applies a border configuration.
+- **`useText(textNameOrOptions, overrideOpts?)` / `useTextId(textId, overrideOpts?)`**: Sets border text with optional override precedence.
 - **`useImage(imageUrl, overrideOpts?)`**: Sets an image. `overrideOpts` ensures precedence over image in final `.options()`.
 - **`useData(data, overrideOpts?)`**: Sets the data. `overrideOpts` ensures precedence over data in final `.options()`.
 - **`useOptions(options, overrideOpts?)`**: Merges general options. `overrideOpts` ensures precedence for these specific options over final `.options()`.
+- **`useId(id)`**, **`useName(name)`**, **`useDescription(description)`**, **`useMetadata(metadata)`**: Attach metadata to the QR code instance when the builder finalizes.
 - **`useSettings(settings)`**: Applies a comprehensive `SettingsOptions` object as a new baseline for the builder chain, **resetting** any configurations previously applied to *that builder instance* via other `use...` methods.
 
 You can chain these methods (e.g., `QRCodeJs.useTemplate(...).useStyle(...).useBorder(...).useImage(...)`) before finalizing with `.options(...)` or `.build()`. Options are merged progressively, with later calls overriding earlier ones for the same properties, unless an `override: true` was used.

package/lib/core/qr-code-js.d.ts

@@ -79,7 +79,6 @@ export declare class QRCodeJs {
      * Sets the static style to be used as a base for new instances.
      * Accepts either a predefined style name or a StyleOptions object.
      * @param styleNameOrOptions - The name of the style or the StyleOptions object.
-     * @param styleNameOrOptions - The name of the style or the StyleOptions object.
      * @returns The QRCodeJs class for chaining.
      */
     static setStyle(styleNameOrOptions: string | StyleOptions | null): typeof QRCodeJs;