chore: upgrades and global event types

Barthelemy Bonhomme · Barthelemy Bonhomme · commit 5f4f674bbcb8 · 2025-08-24T10:29:12.000+02:00
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -8,6 +8,9 @@ on:
 jobs:
   publish-npm:
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
diff --git a/.yarn/releases/yarn-4.6.0.cjs b/.yarn/releases/yarn-4.6.0.cjs
diff --git a/.yarn/releases/yarn-4.9.3.cjs b/.yarn/releases/yarn-4.9.3.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.6.0.cjs
+yarnPath: .yarn/releases/yarn-4.9.3.cjs
diff --git a/README.md b/README.md
@@ -262,6 +262,20 @@ Events dispatched on the slider's `element`:
 
 You can use the proxy methods `addEventListener` and `removeEventListener` to listen to them.
 
+If you want proper typing for these events in TypeScript, you can augment the global `HTMLElementEventMap` interface:
+
+```ts
+declare global {
+  interface HTMLElementEventMap {
+    'slide-pass': CustomEvent<number>;
+    'slide-stop': CustomEvent<number>;
+    'slide-start': CustomEvent<number>;
+  }
+}
+```
+
+or copy/import them from `scroll-snap-slider/global.d.ts`.
+
 ## Public Properties
 
 | Property                                 | Description                                                           |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "scroll-snap-slider",
-  "version": "3.3.2",
+  "version": "3.3.3",
   "description": "Mostly CSS slider with great performance.",
   "keywords": [
     "slider",
@@ -31,23 +31,24 @@
   "author": "Barthy Bonhomme <post@barthy.koeln>",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^22.13.8",
-    "@typescript-eslint/eslint-plugin": "^8.25.0",
-    "@typescript-eslint/parser": "^8.25.0",
+    "@microsoft/api-extractor": "^7.52.11",
+    "@types/node": "^24.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.40.0",
+    "@typescript-eslint/parser": "^8.40.0",
     "bash-echolorized": "^1.0.1",
-    "core-js": "^3.40.0",
-    "terser": "^5.39.0",
-    "typedoc": "^0.27.9",
-    "typescript": "^5.8.2",
-    "vite": "5.4.6",
-    "vite-plugin-dts": "^4.5.1"
+    "core-js": "^3.45.1",
+    "terser": "^5.43.1",
+    "typedoc": "^0.28.10",
+    "typescript": "^5.9.2",
+    "unplugin-dts": "1.0.0-beta.0",
+    "vite": "5.4.19"
   },
   "scripts": {
     "build:doc": "typedoc --tsconfig tsconfig.json --options ./typedoc.json src",
     "build:css": "mkdir -p dist && cp src/lib/scroll-snap-slider.css dist/scroll-snap-slider.css",
     "build:demo": "vite build --mode demo --base scroll-snap-slider && yarn build:doc",
-    "build:lib": "vite build --mode lib && yarn build:css",
+    "build:lib": "vite build --mode lib && yarn build:css && cp src/lib/*.d.ts dist/",
     "dev": "vite dev"
   },
-  "packageManager": "yarn@4.6.0"
+  "packageManager": "yarn@4.9.3"
 }
diff --git a/src/demo/slider-multi.ts b/src/demo/slider-multi.ts
@@ -1,4 +1,4 @@
-import { ScrollSnapSlider } from '../lib'
+import { ScrollSnapSlider } from 'scroll-snap-slider'
 
 const sliderMultiElement = document.querySelector<HTMLElement>('.scroll-snap-slider.-multi')
 const sliderMulti = new ScrollSnapSlider({ element: sliderMultiElement })
diff --git a/src/lib/ScrollSnapPlugin.ts b/src/lib/ScrollSnapPlugin.ts
@@ -32,4 +32,4 @@ export abstract class ScrollSnapPlugin {
    */
   public abstract disable (): void
 
-}
+}
diff --git a/src/lib/ScrollSnapSlider.ts b/src/lib/ScrollSnapSlider.ts
@@ -7,14 +7,6 @@ export type ScrollSnapSliderOptions = Partial<ScrollSnapSlider> & {
   element: HTMLElement
 }
 
-declare global {
-  interface HTMLElementEventMap {
-    'slide-pass': CustomEvent<number>;
-    'slide-stop': CustomEvent<number>;
-    'slide-start': CustomEvent<number>;
-  }
-}
-
 /**
  * Mostly CSS slider with great performance.
  */
diff --git a/src/lib/global.d.ts b/src/lib/global.d.ts
@@ -0,0 +1,9 @@
+declare global {
+  interface HTMLElementEventMap {
+    'slide-pass': CustomEvent<number>;
+    'slide-stop': CustomEvent<number>;
+    'slide-start': CustomEvent<number>;
+  }
+}
+
+export {}
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,7 +9,7 @@
     "outDir": "dist",
     "target": "ESNext",
     "declaration": true,
-    "moduleResolution": "Node",
+    "moduleResolution": "node",
     "types": [],
     "paths": {
       "@/*": ["./src/*"],
diff --git a/vite.config.ts b/vite.config.ts
@@ -1,14 +1,18 @@
 import { resolve } from 'path'
+import dts from 'unplugin-dts/vite'
 import { defineConfig } from 'vite'
-import dts from 'vite-plugin-dts'
 
 
 export default defineConfig(({ mode }) => {
-  if(mode === 'lib') {
+  if (mode === 'lib') {
     return {
       base: './',
       plugins: [
-        dts({ rollupTypes: true })
+        dts({
+          include: ['src/lib/**/*'],
+          bundleTypes: true,
+          copyDtsFiles: true
+        }),
       ],
       build: {
         target: 'ESNext',
@@ -18,8 +22,8 @@ export default defineConfig(({ mode }) => {
           entry: resolve(__dirname, 'src/lib/index.ts'),
           name: 'ScrollSnapSlider',
           formats: ['es', 'cjs', 'umd', 'iife'],
-          fileName: 'scroll-snap-slider'
-        }
+          fileName: 'scroll-snap-slider',
+        },
       },
     }
   }
@@ -29,17 +33,17 @@ export default defineConfig(({ mode }) => {
     resolve: {
       alias: {
         '@': resolve(__dirname, './src'),
-        'scroll-snap-slider': resolve(__dirname, './src/lib/index.ts')
-      }
+        'scroll-snap-slider': resolve(__dirname, './src/lib/index.ts'),
+      },
     },
     build: {
       emptyOutDir: true,
       outDir: resolve(__dirname, './demo'),
       rollupOptions: {
         input: {
           main: resolve(__dirname, './src/demo/index.html'),
-        }
-      }
-    }
+        },
+      },
+    },
   }
 })
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`nodeLinker: node-modules`
`2`	`2`
`3`		`-yarnPath: .yarn/releases/yarn-4.6.0.cjs`
	`3`	`+yarnPath: .yarn/releases/yarn-4.9.3.cjs`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ScrollSnapSlider } from '../lib'`
	`1`	`+import { ScrollSnapSlider } from 'scroll-snap-slider'`
`2`	`2`
`3`	`3`	`const sliderMultiElement = document.querySelector<HTMLElement>('.scroll-snap-slider.-multi')`
`4`	`4`	`const sliderMulti = new ScrollSnapSlider({ element: sliderMultiElement })`
-Original file line number
+Diff line change
    */
   public abstract disable (): void
 -}
 +}