@gridd/feedback-stickers 1.0.2 → 1.0.4

package/README.md

@@ -62,14 +62,20 @@ The package is published to npm as `@gridd/feedback-stickers` and is available o
 ```
 
 > **SRI integrity hashes** — for pinned production deployments, generate a hash with:
+>
 > ```bash
 > curl -s https://cdn.jsdelivr.net/npm/@gridd/feedback-stickers@1.0.0/dist/feedback-stickers.min.js \
 >   | openssl dgst -sha384 -binary | openssl base64 -A
 > ```
+>
 > Then add it to the tag:
+>
 > ```html
-> <script src="https://cdn.jsdelivr.net/npm/@gridd/feedback-stickers@1.0.0/dist/feedback-stickers.min.js"
->         integrity="sha384-<hash>" crossorigin="anonymous"></script>
+> <script
+>   src="https://cdn.jsdelivr.net/npm/@gridd/feedback-stickers@1.0.0/dist/feedback-stickers.min.js"
+>   integrity="sha384-<hash>"
+>   crossorigin="anonymous"
+> ></script>
 > ```
 
 ### From a local file
@@ -88,7 +94,7 @@ Inline the script so the HTML is self-contained and can be shared as a single at
 
 ```html
 <script>
-/* paste contents of dist/feedback-stickers.min.js here */
+  /* paste contents of dist/feedback-stickers.min.js here */
 </script>
 ```
 
@@ -109,33 +115,33 @@ echo '</script>' >> page-review.html
 
 Click the **📌 button** in the bottom-right corner of any page to open the panel.
 
-| Control | Purpose |
-|---|---|
-| **Reviewer** field | Your name or initials — shown on every sticky you place |
-| **Color grid** | 12 color categories; click a swatch to select it as the active color |
-| Color labels | Click the small text under any swatch to rename that category; saved globally in the browser |
-| **Start Reviewing** | Activates placement mode (cursor turns to crosshair) |
-| **Stop Reviewing** | Deactivates placement mode; stickies remain visible |
-| **Export YAML** | Downloads all stickies as a `.review.yaml` file |
-| **Import YAML** | Loads a `.review.yaml` file and merges its stickies onto the page |
-| **Clear** | Removes all stickies for the current page (asks for confirmation) |
+| Control             | Purpose                                                                                      |
+| ------------------- | -------------------------------------------------------------------------------------------- |
+| **Reviewer** field  | Your name or initials — shown on every sticky you place                                      |
+| **Color grid**      | 12 color categories; click a swatch to select it as the active color                         |
+| Color labels        | Click the small text under any swatch to rename that category; saved globally in the browser |
+| **Start Reviewing** | Activates placement mode (cursor turns to crosshair)                                         |
+| **Stop Reviewing**  | Deactivates placement mode; stickies remain visible                                          |
+| **Export YAML**     | Downloads all stickies as a `.review.yaml` file                                              |
+| **Import YAML**     | Loads a `.review.yaml` file and merges its stickies onto the page                            |
+| **Clear**           | Removes all stickies for the current page (asks for confirmation)                            |
 
 ### Color categories (defaults)
 
-| Color | Default label | Suggested use |
-|---|---|---|
-| 🟡 Yellow | Note | General observation |
-| 🟠 Amber | Flag | Needs attention |
-| 🟧 Orange | Caution | Risk or concern |
-| 🔴 Red | Blocker | Must fix before release |
-| 🌸 Rose | Critical | Severe issue |
-| 💗 Pink | Design | Visual / layout feedback |
-| 🟣 Purple | UX | Interaction / flow feedback |
-| 🔵 Indigo | Dev | Implementation comment |
-| 💙 Blue | Info | Background context |
-| 🩵 Teal | Content | Copy or text feedback |
-| 🟢 Green | OK | Explicitly approved |
-| 🟩 Lime | Approved | Sign-off |
+| Color     | Default label | Suggested use               |
+| --------- | ------------- | --------------------------- |
+| 🟡 Yellow | Note          | General observation         |
+| 🟠 Amber  | Flag          | Needs attention             |
+| 🟧 Orange | Caution       | Risk or concern             |
+| 🔴 Red    | Blocker       | Must fix before release     |
+| 🌸 Rose   | Critical      | Severe issue                |
+| 💗 Pink   | Design        | Visual / layout feedback    |
+| 🟣 Purple | UX            | Interaction / flow feedback |
+| 🔵 Indigo | Dev           | Implementation comment      |
+| 💙 Blue   | Info          | Background context          |
+| 🩵 Teal   | Content       | Copy or text feedback       |
+| 🟢 Green  | OK            | Explicitly approved         |
+| 🟩 Lime   | Approved      | Sign-off                    |
 
 Labels are customisable per session. Renamed labels are saved in the browser's local storage and persist across page loads.
 
@@ -167,7 +173,7 @@ Build the script and embed it in the HTML page you want reviewed:
 <script src="feedback-stickers.min.js"></script>
 ```
 
-Or inline the minified script for a single self-contained file (see *Single-file distribution* above).
+Or inline the minified script for a single self-contained file (see _Single-file distribution_ above).
 
 Send the HTML file to the reviewer. If the script is not inlined, include `feedback-stickers.min.js` alongside it in the same folder (or zip archive).
 
@@ -239,11 +245,11 @@ stickers:
     comment: "This section needs a clearer heading"
     color: orange
     position:
-      xPct: 0.4531        # fallback: fraction of page width
-      yPct: 0.2341        # fallback: fraction of page height
-      anchorSelector: "#intro > p:nth-of-type(2)"   # element the sticky is pinned to
-      anchorOffsetXPct: 0.05   # position within that element (fraction of its width)
-      anchorOffsetYPct: 0.12   # position within that element (fraction of its height)
+      xPct: 0.4531 # fallback: fraction of page width
+      yPct: 0.2341 # fallback: fraction of page height
+      anchorSelector: "#intro > p:nth-of-type(2)" # element the sticky is pinned to
+      anchorOffsetXPct: 0.05 # position within that element (fraction of its width)
+      anchorOffsetYPct: 0.12 # position within that element (fraction of its height)
     minimized: false
     rotation: -1.2
     createdAt: "2026-05-28T10:00:00.000Z"
@@ -251,6 +257,7 @@ stickers:
 ```
 
 **Position resolution order:**
+
 1. If `anchorSelector` is present and the element is found on the page → position relative to that element.
 2. Otherwise fall back to `xPct` / `yPct` (percentage of page scroll dimensions).
 3. Legacy files with `top` / `left` (absolute pixels from older versions) are still accepted on import.
@@ -260,3 +267,82 @@ stickers:
 ## Browser compatibility
 
 Requires a modern browser with Shadow DOM v1 support: Chrome 53+, Firefox 63+, Safari 10.1+, Edge 79+. All features used (Shadow DOM, Pointer Events, `crypto.randomUUID`, `CSS.escape`, `URL.createObjectURL`) are available without polyfills in these versions.
+
+# NOTICE
+
+https://github.com/GriddApp/gridd-docusaurus-feedback-plugin
+
+Copyright (c) 2026 DeckAI Inc. All rights reserved.
+
+## 1. LICENCE
+
+This library is licensed under the GNU Lesser General Public License, version 3 ("LGPL v3"), the full text of which is available at:
+https://www.gnu.org/licenses/lgpl-3.0.html
+
+You may use, copy, modify, and distribute this library under the terms of the LGPL v3. If you modify the library, you must release your modifications under the same licence.
+
+## 2. ADDITIONAL ATTRIBUTION REQUIREMENT (permitted additional term under LGPL v3 § 7)
+
+As a condition of using this library — whether via CDN, inline embed, or any other distribution method — you must comply with the following attribution requirement in addition to the LGPL v3 terms:
+
+a) SCRIPT BANNER PRESERVATION
+
+The copyright and attribution banner comment at the top of feedback-stickers.min.js must be preserved in its entirety in all copies and distributions, including inline embeds. The banner reads:
+
+```js
+/*!
+ * @gridd/feedback-stickers v1.0.0
+ * Copyright (c) 2026 DeckAI Inc. (deckai.co)
+ * Licensed under LGPL v3 + Attribution Notice
+ * https://www.npmjs.com/package/@gridd/feedback-stickers
+ *
+ * You may use and redistribute this library freely under LGPL v2.1,
+ * provided this banner is preserved in all copies (including inline embeds)
+ * and attribution is given in your project documentation.
+ * See NOTICE file for full attribution requirements.
+ * Commercial / white-label licences: hello@deckai.co
+ */
+```
+
+You must not alter, obscure, or remove this banner.
+
+b) DOCUMENTATION OR README ATTRIBUTION
+
+Any project, product, tool, or document that ships with or depends on this library must include the following notice in its documentation, README, or equivalent end-user-facing material:
+
+> Feedback annotation powered by @gridd/feedback-stickers (deckai.co) — used under LGPL v3 + Attribution Notice.
+
+A hyperlink to https://deckai.co or https://github.com/GriddApp/gridd-docusaurus-feedback-plugin is strongly preferred wherever the format supports links.
+
+c) INLINE EMBED COMPLIANCE
+
+When this library is embedded inline (i.e. the minified source
+is copied directly into a `<script>` tag rather than loaded from
+an external URL), the banner comment in clause (a) above must
+still be present immediately before the inlined code. The inline
+embed does not exempt you from either clause (a) or clause (b).
+
+d) NO REBRANDING
+
+You may not republish this library — whether modified or unmodified — under a name, npm package identifier, or CDN path that does not include the "@gridd/" namespace prefix or that removes or replaces the "DeckAI" attribution, without a separate
+written commercial licence from DeckAI Inc.
+
+## 3. COMMERCIAL LICENSING
+
+If you wish to:
+
+— use this library without the attribution requirements above, or
+— white-label or rebrand the library under a different namespace, or
+— incorporate it into a commercial product sold to end-users where the LGPL v3 terms are incompatible with your distribution model,
+
+please contact DeckAI Inc. to obtain a commercial licence:
+
+fajth@deckai.co
+
+https://deckai.co
+
+## 4. NO WARRANTY
+
+This library is provided "as is", without warranty of any kind,
+express or implied. See the LGPL v3 for the full disclaimer of
+warranties and limitation of liability.

package/dist/feedback-stickers.min.js

@@ -1,3 +1,15 @@
+/*!
+ * @gridd/feedback-stickers v1.0.3
+ * Copyright (c) 2026 DeckAI Inc. (deckai.co)
+ * Licensed under LGPL v3 + Attribution Notice
+ * https://www.npmjs.com/package/@gridd/feedback-stickers
+ *
+ * You may use and redistribute this library freely under LGPL v2.1,
+ * provided this banner is preserved in all copies (including inline embeds)
+ * and attribution is given in your project documentation.
+ * See NOTICE file for full attribution requirements.
+ * Commercial / white-label licences: hello@deckai.co
+ */
 "use strict";var FeedbackStickers=(()=>{var H=["yellow","amber","orange","red","rose","pink","purple","indigo","blue","teal","green","lime"],D={yellow:{bg:"#FDE047",border:"#CA8A04",text:"#000",defaultLabel:"Question"},amber:{bg:"#FCD34D",border:"#B45309",text:"#000",defaultLabel:"Comment"},orange:{bg:"#FB923C",border:"#C2410C",text:"#000",defaultLabel:"Check"},red:{bg:"#F87171",border:"#B91C1C",text:"#fff",defaultLabel:"Blocker"},rose:{bg:"#FB7185",border:"#BE123C",text:"#fff",defaultLabel:"Critical"},pink:{bg:"#F472B6",border:"#BE185D",text:"#fff",defaultLabel:"Visual"},purple:{bg:"#C084FC",border:"#7E22CE",text:"#fff",defaultLabel:"Message"},indigo:{bg:"#818CF8",border:"#3730A3",text:"#fff",defaultLabel:"Technical"},blue:{bg:"#60A5FA",border:"#1D4ED8",text:"#fff",defaultLabel:"Usability"},teal:{bg:"#2DD4BF",border:"#0F766E",text:"#000",defaultLabel:"FYI"},green:{bg:"#4ADE80",border:"#15803D",text:"#000",defaultLabel:"Looks good"},lime:{bg:"#A3E635",border:"#4D7C0F",text:"#000",defaultLabel:"Approved"}};var U="fs_",ce=U+"colorLabels",de=U+"reviewer";function ke(s){let r=2166136261;for(let a=0;a<s.length;a++)r^=s.charCodeAt(a),r=Math.imul(r,16777619)>>>0;return r.toString(36)}function pe(){return U+"s_"+ke(location.href)}function J(s,r){try{let a=localStorage.getItem(s);return a!==null?JSON.parse(a):r}catch{return r}}function V(s,r){try{localStorage.setItem(s,JSON.stringify(r))}catch{}}function G(){return J(pe(),[])}function C(s){V(pe(),s)}function fe(s){return{...s,...J(ce,{})}}function Q(s){V(ce,s)}function ue(){return J(de,"")}function me(s){V(de,s)}function w(s){return'"'+s.replace(/\\/g,"\\\\").replace(/"/g,'\\"').replace(/\n/g,"\\n").replace(/\r/g,"")+'"'}function ge(s){let r=['version: "1.0"',"page:",`  url: ${w(s.page.url)}`,`  title: ${w(s.page.title)}`,`  exportedAt: ${w(s.page.exportedAt)}`,"colorLabels:",...Object.entries(s.colorLabels).map(([a,p])=>`  ${a}: ${w(p)}`),"stickers:"];if(s.stickers.length===0)r.push("  []");else for(let a of s.stickers){let p=a.position;r.push(`  - id: ${w(a.id)}`,`    reviewer: ${w(a.reviewer)}`,`    comment: ${w(a.comment)}`,`    color: ${a.color}`,"    position:",`      xPct: ${p.xPct??0}`,`      yPct: ${p.yPct??0}`),p.anchorSelector&&r.push(`      anchorSelector: ${w(p.anchorSelector)}`,`      anchorOffsetXPct: ${p.anchorOffsetXPct??0}`,`      anchorOffsetYPct: ${p.anchorOffsetYPct??0}`),r.push(`    minimized: ${a.minimized}`,`    rotation: ${a.rotation??0}`,`    createdAt: ${w(a.createdAt)}`,`    updatedAt: ${w(a.updatedAt)}`)}return r.join(`
 `)+`
 `}function be(s){let r={version:"1.0",page:{url:"",title:"",exportedAt:""},colorLabels:{},stickers:[]},a=s.split(`

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@gridd/feedback-stickers",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Drop-in sticky-note annotation panel for any HTML page. Self-contained IIFE — no framework required.",
   "keywords": ["feedback", "review", "sticky", "annotation", "stickers", "docusaurus"],
-  "license": "UNLICENSED",
+  "license": "LGPL-3.0-only",
   "main": "dist/feedback-stickers.min.js",
   "jsdelivr": "dist/feedback-stickers.min.js",
   "unpkg": "dist/feedback-stickers.min.js",
@@ -11,8 +11,8 @@
     "dist/feedback-stickers.min.js"
   ],
   "scripts": {
-    "build": "esbuild src/index.ts --bundle --format=iife --global-name=FeedbackStickers --minify --target=es2020 --outfile=dist/feedback-stickers.min.js",
-    "dev": "esbuild src/index.ts --bundle --format=iife --global-name=FeedbackStickers --target=es2020 --sourcemap --outfile=dist/feedback-stickers.js --watch"
+    "build": "node build.mjs",
+    "dev": "node build.mjs --watch"
   },
   "devDependencies": {
     "esbuild": "^0.21.0",