@scanly/react 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,3 @@
1
+ # @scanly/react
2
+
3
+ Thin lifecycle adapter around `@scanly/browser`. Decoding remains outside React; unmount disposes the browser session and Worker.
@@ -0,0 +1,12 @@
1
+ import { BrowserCaptureSession, type BrowserCaptureSessionOptions, type BrowserScanFileOptions } from "@scanly/browser";
2
+ import type { ScanOutcome } from "@scanly/core";
3
+ export interface UseScanlyResult {
4
+ session: BrowserCaptureSession;
5
+ outcome: ScanOutcome | null;
6
+ scanning: boolean;
7
+ scanFile(file: File, options?: BrowserScanFileOptions): Promise<ScanOutcome>;
8
+ cancel(): void;
9
+ reset(): void;
10
+ }
11
+ export declare function useScanly(options?: BrowserCaptureSessionOptions): UseScanlyResult;
12
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAE,KAAK,4BAA4B,EAAE,KAAK,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACxH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,qBAAqB,CAAC;IAC/B,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7E,MAAM,IAAI,IAAI,CAAC;IACf,KAAK,IAAI,IAAI,CAAC;CACf;AAED,wBAAgB,SAAS,CAAC,OAAO,GAAE,4BAAiC,GAAG,eAAe,CAsBrF"}
package/dist/index.js ADDED
@@ -0,0 +1,28 @@
1
+ "use client";
2
+ import { useCallback, useEffect, useState } from "react";
3
+ import { BrowserCaptureSession } from "@scanly/browser";
4
+ export function useScanly(options = {}) {
5
+ const [session] = useState(() => new BrowserCaptureSession(options));
6
+ const [outcome, setOutcome] = useState(null);
7
+ const [scanning, setScanning] = useState(false);
8
+ useEffect(() => {
9
+ session.initialize();
10
+ session.start();
11
+ return () => { void session.dispose(); };
12
+ }, [session]);
13
+ const scanFile = useCallback(async (file, scanOptions = {}) => {
14
+ setScanning(true);
15
+ try {
16
+ const next = await session.scanFile(file, scanOptions);
17
+ setOutcome(next);
18
+ return next;
19
+ }
20
+ finally {
21
+ setScanning(false);
22
+ }
23
+ }, [session]);
24
+ const cancel = useCallback(() => { session.cancel(); setScanning(false); }, [session]);
25
+ const reset = useCallback(() => { session.cancel(); setScanning(false); setOutcome(null); }, [session]);
26
+ return { session, outcome, scanning, scanFile, cancel, reset };
27
+ }
28
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAEb,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAkE,MAAM,iBAAiB,CAAC;AAYxH,MAAM,UAAU,SAAS,CAAC,UAAwC,EAAE;IAClE,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAqB,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChD,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,CAAC,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,IAAU,EAAE,cAAsC,EAAE,EAAE,EAAE;QAC1F,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;YACvD,UAAU,CAAC,IAAI,CAAC,CAAC;YACjB,OAAO,IAAI,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,WAAW,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACvF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACxG,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACjE,CAAC"}
package/package.json ADDED
@@ -0,0 +1,33 @@
1
+ {
2
+ "name": "@scanly/react",
3
+ "version": "2.0.0",
4
+ "description": "React lifecycle adapter for Scanly browser SDK",
5
+ "license": "MIT",
6
+ "type": "module",
7
+ "sideEffects": false,
8
+ "main": "./dist/index.js",
9
+ "types": "./dist/index.d.ts",
10
+ "exports": {
11
+ ".": {
12
+ "types": "./dist/index.d.ts",
13
+ "import": "./dist/index.js"
14
+ }
15
+ },
16
+ "files": [
17
+ "dist",
18
+ "README.md"
19
+ ],
20
+ "scripts": {
21
+ "build": "tsc -p tsconfig.build.json"
22
+ },
23
+ "dependencies": {
24
+ "@scanly/browser": "2.0.0"
25
+ },
26
+ "peerDependencies": {
27
+ "react": ">=18 <20"
28
+ },
29
+ "devDependencies": {
30
+ "@types/react": "^18.3.3",
31
+ "react": "^18.3.1"
32
+ }
33
+ }