iconly 3.0.0-dev.2 → 3.0.1-rc.1

package/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 3.0.0
+
+### Breaking changes
+
+- **API changed**: `new Iconly()` was replaced by `createIconly()`.
+- **Init contract changed**: `init()` no longer throws and no longer returns `void`. It now returns a `Result<void>` that must be checked via `result.ok`.
+- **DOM anchor changed**: the injected sprite wrapper is now a `<div data-iconly="iconset" aria-hidden="true">...</div>` inside the configured `container` (previously `id="iconset"`).
+- **Storage is configurable**: caching can use `'indexeddb' | 'memory' | 'session'` or a custom storage implementation.
+
+### Migration guide
+
+#### 1) Constructor → factory
+
+Before:
+
+```js
+import Iconly from 'iconly';
+const iconly = new Iconly({ file: './sprite.svg' });
+await iconly.init();
+```
+
+After:
+
+```js
+import { createIconly } from 'iconly';
+const iconly = createIconly({ file: './sprite.svg' });
+const result = await iconly.init();
+if (!result.ok) console.error(result.error);
+```
+
+#### 2) DOM anchor
+
+Before:
+```html
+#iconset
+```
+
+After (created inside `container`):
+```html
+[data-iconly="iconset"]
+```

package/README.md

@@ -28,6 +28,14 @@ import { createIconly } from 'iconly';
 ```
 <br>
 
+# Upgrading to v3
+- The API is now factory-based: use `createIconly()` instead of `new Iconly()`.
+- `init()` returns a `Result<void>` and never throws.
+- The injected sprite wrapper is now `[data-iconly="iconset"]` inside `container` (instead of `#iconset`).
+
+See `CHANGELOG.md` for details.
+<br>
+
 # Usage
 ```javascript
 const iconLoader = createIconly({
@@ -85,5 +93,4 @@ After `init()`, the SVG sprite is injected into the `container` inside `<div dat
 - You can cancel a fetch by calling `iconLoader.abort()`, which results in a `fetch_aborted` error code.
 
 # License
-
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iconly",
-  "version": "3.0.0-dev.2",
+  "version": "3.0.1-rc.1",
   "description": "Iconly is designed to load and cache SVG icons in the browser, using IndexedDB to store the data. It retrieves the icons from a given SVG file, stores them in IndexedDB, and inserts them into the DOM for easy access and use.",
   "author": "ux-ui.pro",
   "license": "MIT",
@@ -26,7 +26,8 @@
     "format": "biome format --write src tests",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "test": "vitest run",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "prepublishOnly": "yarn clean && yarn build && yarn verify"
   },
   "source": "src/index.ts",
   "main": "dist/index.cjs.js",
@@ -43,6 +44,7 @@
   },
   "files": [
     "dist",
+    "CHANGELOG.md",
     "README.md",
     "LICENSE"
   ],