@stonecrop/beam 0.13.14 → 0.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/beam",
-  "version": "0.13.14",
+  "version": "0.14.0",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -58,6 +58,7 @@
     "vitest": "^4.1.5",
     "vue": "^3.5.33",
     "vue-router": "^5.0.6",
+    "vue-tsc": "^3.3.6",
     "stonecrop-rig": "0.7.0"
   },
   "publishConfig": {
@@ -75,6 +76,7 @@
     "lint:fix": "oxlint --fix",
     "preview": "vite preview",
     "test": "vitest run --coverage.enabled false",
+    "test:types": "vue-tsc --noEmit",
     "test:watch": "vitest watch",
     "test:coverage": "vitest run --coverage",
     "test:ui": "vitest --ui"

package/src/components/ScanInput.vue

@@ -4,9 +4,10 @@
 
 <script setup lang="ts">
 import onScan from 'onscan.js'
+import type { OnScan } from 'onscan.js'
 import { onMounted, onUnmounted } from 'vue'
 
-const emit = defineEmits<{ scanInstance: [instance: onScan] }>()
+const emit = defineEmits<{ scanInstance: [instance: OnScan] }>()
 const props = defineProps<{
 	scanHandler: (barcode: string, qty: number) => void
 }>()

package/src/onscan.d.ts

@@ -0,0 +1,45 @@
+// onscan.js ships no typings and has no @types package, so its import was implicitly `any` —
+// which also made `onScan` unusable as a type. Declared here against the library's actual public
+// surface (v1.5.2); the chainable methods return the singleton itself, which is why `attachTo`
+// hands back something you can call `simulate` on.
+declare module 'onscan.js' {
+	export interface OnScanOptions {
+		onScan?: (scanned: string, qty: number) => void
+		onScanError?: (debug: { message: string }) => void
+		onKeyProcess?: (char: string, event: KeyboardEvent) => void
+		onKeyDetect?: (keyCode: number, event: KeyboardEvent) => void
+		onPaste?: (pasted: string, event: ClipboardEvent) => void
+		keyCodeMapper?: (event: KeyboardEvent) => string | null
+		onScanButtonLongPress?: () => void
+		scanButtonKeyCode?: number | false
+		scanButtonLongPressTime?: number
+		timeBeforeScanTest?: number
+		avgTimeByChar?: number
+		minLength?: number
+		suffixKeyCodes?: number[]
+		prefixKeyCodes?: number[]
+		ignoreIfFocusOn?: boolean | string | Element | Element[]
+		stopPropagation?: boolean
+		preventDefault?: boolean
+		captureEvents?: boolean
+		reactToKeydown?: boolean
+		reactToPaste?: boolean
+		singleScanQty?: number
+	}
+
+	export interface OnScan {
+		/** Attaches the scanner listeners to `target`. Throws if it is already attached. */
+		attachTo(target: EventTarget, options?: OnScanOptions): OnScan
+		detachFrom(target: EventTarget): void
+		getOptions(target: EventTarget): OnScanOptions
+		setOptions(target: EventTarget, options: OnScanOptions): OnScan
+		/** Feeds a scan through as if a scanner produced it. */
+		simulate(target: EventTarget, code: string | number[]): OnScan
+		isScanInProgressFor(target: EventTarget): boolean
+		isAttachedTo(target: EventTarget): boolean
+		decodeKeyEvent(event: KeyboardEvent): string | null
+	}
+
+	const onScan: OnScan
+	export default onScan
+}