@w-lfpup/wctk 0.2.4 → 0.2.5

package/README.md

@@ -1,12 +1,12 @@
 # Wctk-JS
 
-An SSR friendly (w)eb(c)omponent (t)ool (k)it without dependencies.
+An SSR friendly webcomponent tool kit without dependencies.
 
-[![Builds](https://github.com/w-lfpup/wctk-js/actions/workflows/builds.yml/badge.svg)](https://github.com/w-lfpup/wctk-js/actions/workflows/builds.yml)
+[![Tests](https://github.com/w-lfpup/wctk-js/actions/workflows/tests.yml/badge.svg)](https://github.com/w-lfpup/wctk-js/actions/workflows/tests.yml)
 
 ## About
 
-The `wctk` is a collection of bare-metal facades over vanilla browser apis. They provide the basics for
+The `wctk` is a collection of bare-metal facades over web apis. They provide the basics for
 events, reactivity, and forms.
 
 There are no base classes, decorators, or mixins.
@@ -20,25 +20,23 @@ Four (4) controllers help developers:
 - listen for [events](./docs/events.md)
 - cache selector [queries](./docs/query_selector.md)
 
-Controllers are flexible and not restricted to webcomponents. The can be used on any `HTMLElement`.
-
 ## Install
 
-Install directly from github.
+Install from npm:
 
 ```bash
-npm install --save-dev https://github.com/w-lfpup/wctk-js/
+npm install --save-dev @w-lfpup/wctk
 ```
 
-Install with npm.
+Install directly from github:
 
 ```bash
-npm install --save-dev @w-lfpup/wctk
+npm install --save-dev https://github.com/w-lfpup/wctk-js/
 ```
 
 ## Create a webcomponent
 
-Add a `Wc` controller to a custom element with only one line
+Add a `Wc` controller to a custom element.
 
 ```ts
 import { Wc } from "wctk";
@@ -67,7 +65,7 @@ If you know vanilla javascript and the DOM you are good to go.
 The `wctk` is designed with SSR and declarative shadow dom in mind. Developers
 can pick up what the HTML threw down with interactive SSR friendly webcomponents.
 
-Templating is not provided. You can use lit-html or react or vue. But first consider the majority
+Templating is not provided. But before you reach for lit-html or vue or react, consider the majority
 of components only have a few moving pieces. Do you really need templating for that custom button?
 Do you really need a flux-pattern for that checkbox?
 

package/dist/events.d.ts

@@ -5,7 +5,7 @@ interface GenericEventListenerObject<E extends Event> extends EventListenerObjec
     handleEvent(object: E): void;
 }
 type GenericCallbacks<E extends Event> = GenericEventListener<E> | GenericEventListenerObject<E>;
-type EventMaps = DocumentEventMap & GlobalEventHandlersEventMap & ElementEventMap;
+type EventMaps = DocumentEventMap & HTMLElementEventMap;
 type ListenerMap = Partial<{
     [Property in keyof EventMaps]: GenericCallbacks<EventMaps[Property]>;
 }> | Record<string, EventListenerOrEventListenerObject>;
@@ -14,8 +14,8 @@ interface EventElementInterface {
     removeEventListener: Element["removeEventListener"];
 }
 export interface EventParamsInterface {
-    listeners: ListenerMap;
     connected?: boolean;
+    listeners: ListenerMap;
     target: EventElementInterface;
 }
 export interface EventsInterface {

package/package.json

@@ -4,7 +4,7 @@
 	"main": "dist/mod.js",
 	"description": "A bare-metal webcomponent toolkit",
 	"license": "BSD-3-Clause",
-	"version": "0.2.4",
+	"version": "0.2.5",
 	"scripts": {
 		"prepare": "npm run build",
 		"build": "npm run build:src && npm run build:tests && npm run build:examples",

package/src/events.ts

@@ -12,9 +12,7 @@ type GenericCallbacks<E extends Event> =
 	| GenericEventListener<E>
 	| GenericEventListenerObject<E>;
 
-type EventMaps = DocumentEventMap &
-	GlobalEventHandlersEventMap &
-	ElementEventMap;
+type EventMaps = DocumentEventMap & HTMLElementEventMap;
 
 type ListenerMap =
 	| Partial<{
@@ -32,8 +30,8 @@ interface EventElementInterface {
 }
 
 export interface EventParamsInterface {
-	listeners: ListenerMap;
 	connected?: boolean;
+	listeners: ListenerMap;
 	target: EventElementInterface;
 }
 

package/.github/workflows/browsers.macos.json

@@ -1,51 +0,0 @@
-{
-	"jackrabbit_url": "http://127.0.0.1:4000",
-	"runAsynchronusly": false,
-	"webdrivers": [
-		{
-			"command": "safaridriver -p 4001",
-			"title": "Safari",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://localhost:4001"
-		},
-		{
-			"command": "$GECKOWEBDRIVER/geckodriver -p 4001",
-			"title": "Firefox",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://127.0.0.1:4001",
-			"capabilities": {
-				"alwaysMatch": {
-					"moz:firefoxOptions": {
-						"args": ["-headless"]
-					}
-				}
-			}
-		},
-		{
-			"command": "$CHROMEWEBDRIVER/chromedriver --port=4001",
-			"title": "Chrome",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://localhost:4001",
-			"capabilities": {
-				"alwaysMatch": {
-					"goog:chromeOptions": {
-						"args": ["--headless"]
-					}
-				}
-			}
-		},
-		{
-			"command": "$EDGEWEBDRIVER/msedgedriver --port=4001",
-			"title": "Edge",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://localhost:4001",
-			"capabilities": {
-				"alwaysMatch": {
-					"ms:edgeOptions": {
-						"args": ["--headless"]
-					}
-				}
-			}
-		}
-	]
-}

package/.github/workflows/browsers.ubuntu.json

@@ -1,37 +0,0 @@
-{
-	"jackrabbit_url": "http://127.0.0.1:4000",
-	"runAsynchronusly": false,
-	"webdrivers": [
-		{
-			"title": "Firefox",
-			"command": "$GECKOWEBDRIVER/geckodriver -p 4001",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://localhost:4001",
-			"capabilities": {
-				"alwaysMatch": {
-					"moz:firefoxOptions": {
-						"args": ["-headless"]
-					}
-				}
-			}
-		},
-		{
-			"title": "Chrome",
-			"command": "$CHROMEWEBDRIVER/chromedriver --port=4005",
-			"timeout_ms": 30000,
-			"webdriver_url": "http://localhost:4005",
-			"capabilities": {
-				"alwaysMatch": {
-					"goog:chromeOptions": {
-						"args": [
-							"--headless",
-							"--disbale-gpu",
-							"--disable-dev-shm-usage",
-							"--start-maximized"
-						]
-					}
-				}
-			}
-		}
-	]
-}

package/.github/workflows/tests.yml

@@ -1,27 +0,0 @@
-name: Tests
-
-on:
-    push:
-        branches: ["main"]
-    pull_request:
-        branches: ["main"]
-
-jobs:
-    build_and_test:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v6
-            - uses: actions/setup-node@v6
-            - name: Install
-              run: npm ci
-            - name: Test browsers
-              run: npx jackrabbit_webdriver .github/workflows/browsers.ubuntu.json tests/dist/mod.js
-    build_and_test_macos:
-        runs-on: macos-latest
-        steps:
-            - uses: actions/checkout@v6
-            - uses: actions/setup-node@v6
-            - name: Install
-              run: npm ci
-            - name: Test browsers
-              run: npx jackrabbit_webdriver .github/workflows/browsers.macos.json tests/dist/mod.js

package/.prettierignore

@@ -1,5 +0,0 @@
-dist/
-
-*.html
-*.js
-package-lock.json

package/.prettierrc

@@ -1,5 +0,0 @@
-{
-	"trailingComma": "all",
-	"useTabs": true,
-	"tabWidth": 4
-}

package/jr.json

@@ -1,25 +0,0 @@
-{
-	"jackrabbit_url": "http://localhost:4000",
-	"run_asynchronously": false,
-	"webdrivers": [
-		{
-			"command": "safaridriver -p 4001",
-			"title": "Safari",
-			"timeout_ms": 20000,
-			"webdriver_url": "http://localhost:4001"
-		},
-		{
-			"command": "geckodriver -p 4001",
-			"title": "Firefox",
-			"timeout_ms": 20000,
-			"webdriver_url": "http://localhost:4001",
-			"capabilities": {
-				"alwaysMatch": {
-					"moz:firefoxOptions": {
-						"args": ["-headless"]
-					}
-				}
-			}
-		}
-	]
-}