@medyll/idae-dom-events 0.150.0 → 1.0.0

package/README.md

@@ -1,101 +1,159 @@
-# @medyll/idae-dom-events
-
-`@medyll/idae-dom-events` is a library for observing and reacting to changes in the DOM of web applications. It provides tools to track CSS changes, monitor DOM mutations, and manage various events efficiently, making it an ideal choice for dynamic web applications.
-
-## Features
-
-- **CSS Change Tracking**: Use `CssObserver` to monitor animations, style changes, and resize events.
-- **DOM Mutation Observation**: Use `DomObserver` to track DOM mutations, such as attribute changes, child list modifications, and character data updates.
-- **Event Management**: Efficiently manage DOM-related events.
-
-## Installation
-
-Install the library using npm:
-
-```bash
-npm install @medyll/idae-dom-events
-```
-
-## Usage
-
-### CSS Change Tracking
-
-```typescript
-import { cssDom } from '@medyll/idae-dom-events';
-
-// Track CSS changes on elements with the attribute data-cssDom
-cssDom('[data-cssDom]', {
-    trackChildList: true,
-    trackAttributes: true,
-    trackResize: true
-}).each((element, changes) => {
-    console.log('Modified element:', element);
-
-    if (changes.attributes) {
-        console.log('Attribute changes:', changes.attributes);
-    }
-
-    if (changes.childList) {
-        console.log('Child list modifications:', changes.childList);
-    }
-
-    if (changes.characterData) {
-        console.log('Character data changes:', changes.characterData);
-    }
-
-    if (changes.resize) {
-        console.log('Resize detected:', changes.resize);
-    }
-});
-``` 
-
-### DOM Mutation Observation
-
-```typescript
-import { htmlDom } from '@medyll/idae-dom-events';
-
-htmlDom.track('#widget', {
-    onAttributesChange: (element, mutation) => {
-        console.log('Modified attribute:', mutation);
-    },
-    onChildListChange: (mutation) => {
-        console.log('Child list modified:', mutation);
-    },
-    onCharacterDataChange: (mutation) => {
-        console.log('Character data modified:', mutation);
-    }
-});
-```
-
-## API
-
-### `cssDom(selector, options)`
-
-- **`selector`**: CSS selector to target elements.
-- **`options`**: Options to configure tracking, such as `trackChildList`, `trackAttributes`, or `trackResize`.
-
-#### Methods
-
-- **`each(callback)`**: Tracks changes for each matching element.
-- **`summary(callback)`**: Provides a summary of affected elements.
-
-### `htmlDom.track(selector, options)`
-
-- **`selector`**: Selector or DOM element to observe.
-- **`options`**: Options to configure the types of mutations to track (`onAttributesChange`, `onChildListChange`, etc.).
-
-## Scripts
-
-The following npm scripts are available for development and testing:
-
-- `npm run dev`: Starts the development server.
-- `npm run build`: Compiles the library for production.
-- `npm run test`: Runs unit tests.
-
-## Contribution
-
-Contributions are welcome! Feel free to submit a pull request or open an issue to report bugs or propose features.
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](../../LICENSE) file for more details.
+# @medyll/idae-dom-events
+
+`@medyll/idae-dom-events` is a library for observing and reacting to changes in the DOM of web applications. It provides tools to track CSS changes, monitor DOM mutations, and manage various events efficiently, making it an ideal choice for dynamic web applications.
+
+
+## Features
+
+- **CSS Change Tracking**: Use `cssDom` to monitor animations, style changes, and resize events on selected elements.
+- **DOM Mutation Observation**: Use `htmlDom.track` to observe DOM mutations, such as attribute changes, child list modifications, and character data updates.
+- **Event Management**: Efficiently manage DOM-related events with flexible callback options.
+
+## Installation
+
+Install the library using npm:
+
+```bash
+npm install @medyll/idae-dom-events
+```
+
+## Usage
+
+### CSS Change Tracking
+
+```typescript
+import { cssDom } from '@medyll/idae-dom-events';
+
+// Track CSS changes on elements with the attribute data-cssDom
+cssDom('[data-cssDom]', {
+    trackChildList: true,
+    trackAttributes: true,
+    trackResize: true
+}).each((element, changes) => {
+    console.log('Modified element:', element);
+
+    if (changes.attributes) {
+        console.log('Attribute changes:', changes.attributes);
+    }
+
+    if (changes.childList) {
+        console.log('Child list modifications:', changes.childList);
+    }
+
+    if (changes.characterData) {
+        console.log('Character data changes:', changes.characterData);
+    }
+
+    if (changes.resize) {
+        console.log('Resize detected:', changes.resize);
+    }
+});
+``` 
+
+### DOM Mutation Observation
+
+```typescript
+import { htmlDom } from '@medyll/idae-dom-events';
+
+htmlDom.track('#widget', {
+    onAttributesChange: (element, mutation) => {
+        console.log('Modified attribute:', mutation);
+    },
+    onChildListChange: (mutation) => {
+        console.log('Child list modified:', mutation);
+    },
+    onCharacterDataChange: (mutation) => {
+        console.log('Character data modified:', mutation);
+    }
+});
+```
+
+
+## TypeScript Types
+
+### Types pour `cssDom`
+
+```ts
+export type CssObserverCommands = {
+    start: () => void;
+    pause: () => void;
+    destroy: () => void;
+};
+
+export type CssObserverCallBack = undefined | ((node: Node, mutation?: MutationRecord) => void);
+
+export type CssObserverCallBackSummary = (nodes: Node[]) => void;
+
+export type CssObserverOptions = {
+    strictlyNew: boolean;
+    eventDelay: number;
+    marquee: string;
+    legacyCssPrefix: 'Webkit' | 'Moz' | 'O' | 'ms' | '';
+    debounceDelay: number;
+};
+```
+
+### Types pour `htmlDom.track`
+
+```ts
+type OnMutationType = {
+    onResize?: (
+        element: Node,
+        mutation: MutationRecord,
+        observer: MutationObserver,
+    ) => void;
+    onChange?: (
+        element: Node,
+        mutation: MutationRecord,
+        observer: MutationObserver,
+    ) => void;
+    onAttributesChange?: (
+        element: Node,
+        mutation: MutationRecord,
+        observer: MutationObserver,
+    ) => void;
+    onChildListChange?: (
+        element: Node,
+        mutation: MutationRecord,
+        observer: MutationObserver,
+    ) => void;
+    onCharacterDataChange?: (
+        element: Node,
+        mutation: MutationRecord,
+        observer: MutationObserver,
+    ) => void;
+};
+```
+
+## API
+
+### `cssDom(selector, options)`
+
+- **`selector`**: CSS selector to target elements.
+- **`options`**: Options to configure tracking, such as `trackChildList`, `trackAttributes`, or `trackResize`.
+
+#### Methods
+
+- **`each(callback)`**: Tracks changes for each matching element.
+- **`summary(callback)`**: Provides a summary of affected elements.
+
+### `htmlDom.track(selector, options)`
+
+- **`selector`**: Selector or DOM element to observe.
+- **`options`**: Options to configure the types of mutations to track (`onAttributesChange`, `onChildListChange`, etc.).
+
+## Scripts
+
+The following npm scripts are available for development and testing:
+
+- `npm run dev`: Starts the development server.
+- `npm run build`: Compiles the library for production.
+- `npm run test`: Runs unit tests.
+
+## Contribution
+
+Contributions are welcome! Feel free to submit a pull request or open an issue to report bugs or propose features.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](../../LICENSE) file for more details.

package/cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+
+const pkgJson = require(path.join(__dirname, 'package.json'));
+const packageName = pkgJson.name.replace(/^@[^/]+\//, '');
+const cmd = process.argv[2];
+
+
+if (cmd === 'get-readme') {
+  const readmePath = path.join(__dirname, 'README.md');
+  if (fs.existsSync(readmePath)) {
+    const content = fs.readFileSync(readmePath, 'utf8');
+    console.log(content);
+  } else {
+    console.error('README.md not found in this package.');
+    process.exit(1);
+  }
+} else if (cmd === 'install-skill') {
+  const readline = require('readline');
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  const skillSrc = path.join(__dirname, 'SKILL.md');
+  const skillDest = path.resolve(__dirname, `../../../.github/skills/${packageName}/SKILL.md`);
+  if (!fs.existsSync(skillSrc)) {
+    console.error('SKILL.md not found in this package.');
+    process.exit(1);
+  }
+  rl.question(`This will copy SKILL.md to .github/skills/${packageName}/SKILL.md. Continue? (y/n): `, (answer) => {
+    if (answer.trim().toLowerCase() === 'y' || answer.trim().toLowerCase() === 'yes') {
+      fs.mkdirSync(path.dirname(skillDest), { recursive: true });
+      fs.copyFileSync(skillSrc, skillDest);
+      console.log(`SKILL.md installed to .github/skills/${packageName}/SKILL.md`);
+    } else {
+      console.log('Operation cancelled.');
+    }
+    rl.close();
+  });
+} else {
+  console.log('Usage: <cli> get-readme | install-skill');
+  process.exit(1);
+}

package/dist/components/content.html

@@ -1,44 +1,44 @@
-<script lang="ts">
-	const id = 'aaa';
-	const red = new ResizeObserver((entries) => {
-		for (let entry of entries) {
-			console.log('Element:', entry.target);
-			console.log('Width:', entry.contentRect.width);
-			console.log('Height:', entry.contentRect.height);
-			console.log('Box:', entry.contentRect);
-			console.log('Padding:', entry.contentRect.padding);
-		}
-	});
-	red.observe(element);
-
-	let data;
-	data.onchange = () => console.log(element);
-</script>
-<content id="{id}">
-	<bind from="company.name"></bind>
-	<nav>
-		<loop
-			data-url="api/users"
-			collection="users"
-			filter="where:user.name=*jean*"
-			sort="name"
-			groupBy="field"
-			toggle=""
-		>
-			<h2 slot="title">title once</h2>
-			<div mdl="component/li-item" collection="users" data="" data-id="">inner content</div>
-			<be-item component>inner content</be-item>
-		</loop>
-	</nav>
-	<if>
-		<elseif>
-			<div>cond 1</div>
-		</elseif>
-		<else> cond 2 </else>
-	</if>
-	<slot> </slot>
-</content>
-<style>
-	#id {
-	}
-</style>
+<script lang="ts">
+	const id = 'aaa';
+	const red = new ResizeObserver((entries) => {
+		for (let entry of entries) {
+			console.log('Element:', entry.target);
+			console.log('Width:', entry.contentRect.width);
+			console.log('Height:', entry.contentRect.height);
+			console.log('Box:', entry.contentRect);
+			console.log('Padding:', entry.contentRect.padding);
+		}
+	});
+	red.observe(element);
+
+	let data;
+	data.onchange = () => console.log(element);
+</script>
+<content id="{id}">
+	<bind from="company.name"></bind>
+	<nav>
+		<loop
+			data-url="api/users"
+			collection="users"
+			filter="where:user.name=*jean*"
+			sort="name"
+			groupBy="field"
+			toggle=""
+		>
+			<h2 slot="title">title once</h2>
+			<div mdl="component/li-item" collection="users" data="" data-id="">inner content</div>
+			<be-item component>inner content</be-item>
+		</loop>
+	</nav>
+	<if>
+		<elseif>
+			<div>cond 1</div>
+		</elseif>
+		<else> cond 2 </else>
+	</if>
+	<slot> </slot>
+</content>
+<style>
+	#id {
+	}
+</style>

package/dist/cssDom.js

@@ -307,13 +307,13 @@ export class CssObserver {
     createStyleFragment(selector, animationName) {
         if ('adoptedStyleSheets' in Document.prototype && 'replace' in CSSStyleSheet.prototype) {
             const sheet = new CSSStyleSheet();
-            const styleContent = `@${this.options.legacyCssPrefix}keyframes ${animationName} {
-                from { outline: 1px solid transparent; }
-                to { outline: 0px solid transparent; }
-            }
-            ${selector} {
-                animation-duration: 0.0001s !important;
-                ${this.options.legacyCssPrefix}animation-name: ${animationName} !important;
+            const styleContent = `@${this.options.legacyCssPrefix}keyframes ${animationName} {
+                from { outline: 1px solid transparent; }
+                to { outline: 0px solid transparent; }
+            }
+            ${selector} {
+                animation-duration: 0.0001s !important;
+                ${this.options.legacyCssPrefix}animation-name: ${animationName} !important;
             }`;
             sheet.replaceSync(styleContent);
             document.adoptedStyleSheets.push(sheet);
@@ -321,13 +321,13 @@ export class CssObserver {
         }
         else {
             const style = document.createElement('style');
-            style.textContent = `@${this.options.legacyCssPrefix}keyframes ${animationName} {
-                from { outline: 1px solid transparent; }
-                to { outline: 0px solid transparent; }
-            }
-            ${selector} {
-                animation-duration: 0.0001s !important;
-                ${this.options.legacyCssPrefix}animation-name: ${animationName} !important;
+            style.textContent = `@${this.options.legacyCssPrefix}keyframes ${animationName} {
+                from { outline: 1px solid transparent; }
+                to { outline: 0px solid transparent; }
+            }
+            ${selector} {
+                animation-duration: 0.0001s !important;
+                ${this.options.legacyCssPrefix}animation-name: ${animationName} !important;
             }`;
             document.head.appendChild(style);
             return style;

package/package.json

@@ -1,66 +1,76 @@
-{
-  "name": "@medyll/idae-dom-events",
-  "version": "0.150.0",
-  "scope": "@medyll",
-  "description": "dom-events is a powerful library for observing and reacting to DOM changes in web applications. It provides tools to track CSS changes, monitor DOM mutations, and handle various events efficiently, making it ideal for dynamic web applications.",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "!dist/**/*.test.*",
-    "!dist/**/*.spec.*"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "devDependencies": {
-    "@playwright/test": "^1.51.1",
-    "@sveltejs/adapter-auto": "^5.0.0",
-    "@sveltejs/kit": "^2.20.2",
-    "@sveltejs/package": "^2.3.10",
-    "@sveltejs/vite-plugin-svelte": "^5.0.3",
-    "@types/eslint": "9.6.1",
-    "@typescript-eslint/eslint-plugin": "^8.28.0",
-    "@typescript-eslint/parser": "^8.28.0",
-    "@vitest/browser": "^3.0.9",
-    "eslint": "^9.23.0",
-    "eslint-config-prettier": "^10.1.1",
-    "eslint-plugin-svelte": "^3.3.3",
-    "happy-dom": "^17.4.4",
-    "prettier": "^3.5.3",
-    "prettier-plugin-svelte": "^3.3.3",
-    "svelte": "^5.25.3",
-    "svelte-check": "^4.1.5",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.2",
-    "vite": "^6.2.3",
-    "vitest": "^3.0.9",
-    "@medyll/idae-prettier-config": "1.2.1"
-  },
-  "types": "./dist/index.d.ts",
-  "type": "module",
-  "dependencies": {
-    "blob": "^0.1.0",
-    "inquirer": "^12.5.0",
-    "puppeteer": "^24.4.0"
-  },
-  "scripts": {
-    "dev": "vite dev",
-    "dev:test": "vite dev --port 3000",
-    "build": "vite build && npm run package",
-    "preview": "vite preview",
-    "package": "svelte-kit sync && svelte-package && publint",
-    "package:watch": "svelte-kit sync && svelte-package --watch",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-    "test": "npm run test:unit",
-    "test:unit": "vitest",
-    "lint": "prettier --check . && eslint .",
-    "format": "prettier --write .",
-    "package:pre": "node scripts/package-pre.js"
-  }
-}
+{
+  "name": "@medyll/idae-dom-events",
+  "bin": {
+    "idae-dom-events": "./cli.js"
+  },
+  "version": "1.0.0",
+  "scope": "medyll",
+  "author": "Lebrun Meddy",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/medyll/idae.git"
+  },
+  "description": "dom-events is a powerful library for observing and reacting to DOM changes in web applications. It provides tools to track CSS changes, monitor DOM mutations, and handle various events efficiently, making it ideal for dynamic web applications.",
+  "scripts": {
+    "dev": "vite dev",
+    "dev:test": "vite dev --port 3000",
+    "build": "vite build && npm run package",
+    "preview": "vite preview",
+    "package": "svelte-kit sync && svelte-package && publint",
+    "package:watch": "svelte-kit sync && svelte-package --watch",
+    "prepublishOnly": "npm run package",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+    "test": "npm run test:unit",
+    "test:unit": "vitest",
+    "lint": "prettier --check . && eslint .",
+    "format": "prettier --write .",
+    "prepackage": "node scripts/package-pre.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@medyll/idae-eslint-config": "latest",
+    "@playwright/test": "^1.51.1",
+    "@semantic-release/github": "^10.3.5",
+    "@sveltejs/adapter-auto": "^5.0.0",
+    "@sveltejs/kit": "^2.20.2",
+    "@sveltejs/package": "^2.3.10",
+    "@sveltejs/vite-plugin-svelte": "^5.0.3",
+    "@types/eslint": "9.6.1",
+    "@typescript-eslint/eslint-plugin": "^8.28.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "@vitest/browser": "^3.0.9",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-svelte": "^3.3.3",
+    "happy-dom": "^17.4.4",
+    "prettier": "^3.5.3",
+    "prettier-plugin-svelte": "^3.3.3",
+    "svelte": "^5.25.3",
+    "svelte-check": "^4.1.5",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.3",
+    "vitest": "^3.0.9"
+  },
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "dependencies": {
+    "blob": "^0.1.0",
+    "inquirer": "^12.5.0",
+    "puppeteer": "^24.4.0"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 medyll
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.