From 94c340c88ed46adf1fbf561751944542d8838e7c Mon Sep 17 00:00:00 2001 From: Zuzanna Elzbieta Szalaty Szalaty Date: Wed, 9 Sep 2026 09:32:56 +0100 Subject: [PATCH] [ADD] barcode_scanner: scanner-first Barcode app core --- barcode_scanner/README.rst | 169 + barcode_scanner/__init__.py | 3 + barcode_scanner/__manifest__.py | 44 + barcode_scanner/i18n/es.po | 59 + barcode_scanner/pyproject.toml | 3 + barcode_scanner/readme/CONTRIBUTORS.md | 2 + barcode_scanner/readme/DESCRIPTION.md | 14 + barcode_scanner/readme/USAGE.md | 59 + barcode_scanner/static/description/icon.png | Bin 0 -> 9455 bytes barcode_scanner/static/description/index.html | 500 +++ .../static/src/img/icon_barcode.svg | 65 + barcode_scanner/static/src/js/api.esm.js | 133 + barcode_scanner/static/src/js/app.esm.js | 66 + barcode_scanner/static/src/js/barcode.esm.js | 408 ++ .../static/src/js/barcode_parser.esm.js | 29 + .../static/src/js/hooks/use_barcode.esm.js | 26 + .../js/hooks/use_barcode_dispatcher.esm.js | 34 + .../src/js/hooks/use_barcode_handler.esm.js | 10 + .../static/src/js/hooks/use_inventory.esm.js | 17 + .../static/src/js/registries.esm.js | 28 + barcode_scanner/static/src/js/router.esm.js | 129 + .../static/src/js/screens/main_screen.esm.js | 71 + .../src/js/services/feedback_service.esm.js | 157 + barcode_scanner/static/src/js/store.esm.js | 12 + .../static/src/js/utils/scan_match.esm.js | 53 + .../static/src/scss/barcode_scanner.scss | 3720 +++++++++++++++++ .../src/xml/barcode_scanner_templates.xml | 66 + .../static/tests/api_error_message.test.js | 63 + barcode_scanner/tests/__init__.py | 1 + barcode_scanner/tests/test_js.py | 23 + barcode_scanner/views/action.xml | 13 + barcode_scanner/views/templates.xml | 10 + 32 files changed, 5987 insertions(+) create mode 100644 barcode_scanner/README.rst create mode 100644 barcode_scanner/__init__.py create mode 100644 barcode_scanner/__manifest__.py create mode 100644 barcode_scanner/i18n/es.po create mode 100644 barcode_scanner/pyproject.toml create mode 100644 barcode_scanner/readme/CONTRIBUTORS.md create mode 100644 barcode_scanner/readme/DESCRIPTION.md create mode 100644 barcode_scanner/readme/USAGE.md create mode 100644 barcode_scanner/static/description/icon.png create mode 100644 barcode_scanner/static/description/index.html create mode 100644 barcode_scanner/static/src/img/icon_barcode.svg create mode 100644 barcode_scanner/static/src/js/api.esm.js create mode 100644 barcode_scanner/static/src/js/app.esm.js create mode 100644 barcode_scanner/static/src/js/barcode.esm.js create mode 100644 barcode_scanner/static/src/js/barcode_parser.esm.js create mode 100644 barcode_scanner/static/src/js/hooks/use_barcode.esm.js create mode 100644 barcode_scanner/static/src/js/hooks/use_barcode_dispatcher.esm.js create mode 100644 barcode_scanner/static/src/js/hooks/use_barcode_handler.esm.js create mode 100644 barcode_scanner/static/src/js/hooks/use_inventory.esm.js create mode 100644 barcode_scanner/static/src/js/registries.esm.js create mode 100644 barcode_scanner/static/src/js/router.esm.js create mode 100644 barcode_scanner/static/src/js/screens/main_screen.esm.js create mode 100644 barcode_scanner/static/src/js/services/feedback_service.esm.js create mode 100644 barcode_scanner/static/src/js/store.esm.js create mode 100644 barcode_scanner/static/src/js/utils/scan_match.esm.js create mode 100644 barcode_scanner/static/src/scss/barcode_scanner.scss create mode 100644 barcode_scanner/static/src/xml/barcode_scanner_templates.xml create mode 100644 barcode_scanner/static/tests/api_error_message.test.js create mode 100644 barcode_scanner/tests/__init__.py create mode 100644 barcode_scanner/tests/test_js.py create mode 100644 barcode_scanner/views/action.xml create mode 100644 barcode_scanner/views/templates.xml diff --git a/barcode_scanner/README.rst b/barcode_scanner/README.rst new file mode 100644 index 0000000..6db1637 --- /dev/null +++ b/barcode_scanner/README.rst @@ -0,0 +1,169 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +=============== +Barcode Scanner +=============== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:ba6365d70b631c205696ddd617c9738e11ae52e29ec43c03f6394bdd7815d1a8 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fbarcode--interface-lightgray.png?logo=github + :target: https://github.com/OCA/barcode-interface/tree/18.0/barcode_scanner + :alt: OCA/barcode-interface +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/barcode-interface-18-0/barcode-interface-18-0-barcode_scanner + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/barcode-interface&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module is the **base framework** of the Barcode suite: a fast, +full-screen scanning application shell for Odoo that other modules +extend. + +It ships no business logic of its own. Instead it exposes the building +blocks feature modules plug into, the same way Odoo widgets +self-register: + +- a full-screen client action and a lightweight in-app router; +- registries for screens, scan handlers and home-screen menu tiles + (``barcode_screens``, ``barcode_scan_handlers``, + ``barcode_menu_tiles``); +- the barcode input service (hardware/keyboard wedge), audio/vibration + feedback, an ORM/API wrapper and shared hooks. + +Install a feature module on top — such as ``barcode_stock`` — to get +actual warehouse operations. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +``barcode_scanner`` is a framework and is not useful on its own: install +a feature module such as ``barcode_stock`` to get actual operations. + +To build your own feature module, register your pieces into the +framework registries — no change to the base module is required. + +Register a screen: + +.. code:: js + + import {barcodeScreens} from "@barcode_scanner/js/registries"; + + barcodeScreens.add("my_screen", {component: MyScreen}); + +Register a scan handler (tried in ``sequence`` order; the first that +returns a truthy value consumes the scan): + +.. code:: js + + import {barcodeScanHandlers} from "@barcode_scanner/js/registries"; + + barcodeScanHandlers.add("my_handler", { + async handle(barcode, parsed, {api, navigate, notify}) { + // return true when handled + }, + }, {sequence: 50}); + +Register a home-screen tile: + +.. code:: js + + import {barcodeMenuTiles} from "@barcode_scanner/js/registries"; + + barcodeMenuTiles.add("my_tile", { + label: "My Screen", + icon: "fa-cube", + action: ({navigate}) => navigate("my_screen"), + }, {sequence: 50}); + +Register a barcode parser (tried in ``sequence`` order before the +built-in EAN13 one; return ``null`` to let the next parser try): + +.. code:: js + + import {barcodeParsers} from "@barcode_scanner/js/registries"; + + barcodeParsers.add("my_symbology", (barcode) => { + // return {type: "...", value: "", ...} or null + }, {sequence: 20}); + +Register a startup task, for data your module needs before the first +scan (``barcode_gs1`` reads its nomenclature this way). Tasks are +awaited when the app opens; one that fails is logged and skipped: + +.. code:: js + + import {barcodeStartupTasks} from "@barcode_scanner/js/registries"; + + barcodeStartupTasks.add("my_config", (env) => loadMyConfig(env.services.orm)); + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Binhex + +Contributors +------------ + +- `Antonio David Ruban Espinal `__ +- `Zuzanna Elzbieta Szalaty + Szalaty `__ + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-szalatyzuzanna| image:: https://github.com/szalatyzuzanna.png?size=40px + :target: https://github.com/szalatyzuzanna + :alt: szalatyzuzanna + +Current `maintainer `__: + +|maintainer-szalatyzuzanna| + +This module is part of the `OCA/barcode-interface `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/barcode_scanner/__init__.py b/barcode_scanner/__init__.py new file mode 100644 index 0000000..406f3fc --- /dev/null +++ b/barcode_scanner/__init__.py @@ -0,0 +1,3 @@ +# The base barcode_scanner module ships no Python models; it is a pure +# JavaScript scanning framework. Feature modules (e.g. barcode_stock) add +# their own models. diff --git a/barcode_scanner/__manifest__.py b/barcode_scanner/__manifest__.py new file mode 100644 index 0000000..1905ac7 --- /dev/null +++ b/barcode_scanner/__manifest__.py @@ -0,0 +1,44 @@ +{ + "name": "Barcode Scanner", + "version": "18.0.1.0.0", + "category": "Hidden", + "summary": "Base scanning framework: client action, registries, scanner " + "input and hooks", + "author": "Binhex, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/barcode-interface", + "maintainers": ["szalatyzuzanna"], + "license": "AGPL-3", + "depends": [ + "web", + ], + "data": [ + "views/action.xml", + "views/templates.xml", + ], + "assets": { + "web.assets_backend": [ + "barcode_scanner/static/src/scss/barcode_scanner.scss", + "barcode_scanner/static/src/xml/barcode_scanner_templates.xml", + "barcode_scanner/static/src/js/registries.esm.js", + "barcode_scanner/static/src/js/barcode_parser.esm.js", + "barcode_scanner/static/src/js/utils/scan_match.esm.js", + "barcode_scanner/static/src/js/barcode.esm.js", + "barcode_scanner/static/src/js/api.esm.js", + "barcode_scanner/static/src/js/router.esm.js", + "barcode_scanner/static/src/js/store.esm.js", + "barcode_scanner/static/src/js/app.esm.js", + "barcode_scanner/static/src/js/services/feedback_service.esm.js", + "barcode_scanner/static/src/js/hooks/use_barcode.esm.js", + "barcode_scanner/static/src/js/hooks/use_barcode_handler.esm.js", + "barcode_scanner/static/src/js/hooks/use_barcode_dispatcher.esm.js", + "barcode_scanner/static/src/js/hooks/use_inventory.esm.js", + "barcode_scanner/static/src/js/screens/main_screen.esm.js", + ], + "web.assets_unit_tests": [ + "barcode_scanner/static/tests/**/*", + ], + }, + "installable": True, + "application": True, + "auto_install": False, +} diff --git a/barcode_scanner/i18n/es.po b/barcode_scanner/i18n/es.po new file mode 100644 index 0000000..b96e053 --- /dev/null +++ b/barcode_scanner/i18n/es.po @@ -0,0 +1,59 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * barcode_scanner +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 18.0\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2026-07-31 11:45+0000\n" +"PO-Revision-Date: 2026-07-31 11:45+0000\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/xml/barcode_scanner_templates.xml:0 +msgid "Avatar" +msgstr "Avatar" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/js/hooks/use_barcode_dispatcher.js:0 +msgid "Barcode not recognized" +msgstr "Código de barras no reconocido" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/js/screens/main_screen.js:0 +msgid "Good afternoon" +msgstr "Buenas tardes" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/js/screens/main_screen.js:0 +msgid "Good evening" +msgstr "Buenas noches" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/js/screens/main_screen.js:0 +msgid "Good morning" +msgstr "Buenos días" + +#. module: barcode_scanner +#. odoo-javascript +#: code:addons/barcode_scanner/static/src/xml/barcode_scanner_templates.xml:0 +msgid "Ready for today's distribution schedule." +msgstr "Listo para la planificación de distribución de hoy." + +#. module: barcode_scanner +#: model:ir.actions.client,name:barcode_scanner.action_barcode_scanner +#: model:ir.ui.menu,name:barcode_scanner.menu_barcode_scanner_root +msgid "Scanner" +msgstr "Escáner" diff --git a/barcode_scanner/pyproject.toml b/barcode_scanner/pyproject.toml new file mode 100644 index 0000000..4231d0c --- /dev/null +++ b/barcode_scanner/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/barcode_scanner/readme/CONTRIBUTORS.md b/barcode_scanner/readme/CONTRIBUTORS.md new file mode 100644 index 0000000..7a07748 --- /dev/null +++ b/barcode_scanner/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +* [Antonio David Ruban Espinal](https://github.com/antoniodavid) +* [Zuzanna Elzbieta Szalaty Szalaty](https://github.com/szalatyzuzanna) diff --git a/barcode_scanner/readme/DESCRIPTION.md b/barcode_scanner/readme/DESCRIPTION.md new file mode 100644 index 0000000..a7a63d6 --- /dev/null +++ b/barcode_scanner/readme/DESCRIPTION.md @@ -0,0 +1,14 @@ +This module is the **base framework** of the Barcode suite: a fast, +full-screen scanning application shell for Odoo that other modules extend. + +It ships no business logic of its own. Instead it exposes the building blocks +feature modules plug into, the same way Odoo widgets self-register: + +- a full-screen client action and a lightweight in-app router; +- registries for screens, scan handlers and home-screen menu tiles + (`barcode_screens`, `barcode_scan_handlers`, `barcode_menu_tiles`); +- the barcode input service (hardware/keyboard wedge), audio/vibration + feedback, an ORM/API wrapper and shared hooks. + +Install a feature module on top — such as `barcode_stock` — to get actual +warehouse operations. diff --git a/barcode_scanner/readme/USAGE.md b/barcode_scanner/readme/USAGE.md new file mode 100644 index 0000000..783a25d --- /dev/null +++ b/barcode_scanner/readme/USAGE.md @@ -0,0 +1,59 @@ +``barcode_scanner`` is a framework and is not useful on its own: install a +feature module such as ``barcode_stock`` to get actual operations. + +To build your own feature module, register your pieces into the framework +registries — no change to the base module is required. + +Register a screen: + +```js +import {barcodeScreens} from "@barcode_scanner/js/registries"; + +barcodeScreens.add("my_screen", {component: MyScreen}); +``` + +Register a scan handler (tried in ``sequence`` order; the first that returns a +truthy value consumes the scan): + +```js +import {barcodeScanHandlers} from "@barcode_scanner/js/registries"; + +barcodeScanHandlers.add("my_handler", { + async handle(barcode, parsed, {api, navigate, notify}) { + // return true when handled + }, +}, {sequence: 50}); +``` + +Register a home-screen tile: + +```js +import {barcodeMenuTiles} from "@barcode_scanner/js/registries"; + +barcodeMenuTiles.add("my_tile", { + label: "My Screen", + icon: "fa-cube", + action: ({navigate}) => navigate("my_screen"), +}, {sequence: 50}); +``` + +Register a barcode parser (tried in ``sequence`` order before the built-in +EAN13 one; return ``null`` to let the next parser try): + +```js +import {barcodeParsers} from "@barcode_scanner/js/registries"; + +barcodeParsers.add("my_symbology", (barcode) => { + // return {type: "...", value: "", ...} or null +}, {sequence: 20}); +``` + +Register a startup task, for data your module needs before the first scan +(``barcode_gs1`` reads its nomenclature this way). Tasks are awaited when the +app opens; one that fails is logged and skipped: + +```js +import {barcodeStartupTasks} from "@barcode_scanner/js/registries"; + +barcodeStartupTasks.add("my_config", (env) => loadMyConfig(env.services.orm)); +``` diff --git a/barcode_scanner/static/description/icon.png b/barcode_scanner/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/barcode_scanner/static/description/index.html b/barcode_scanner/static/description/index.html new file mode 100644 index 0000000..e97e35d --- /dev/null +++ b/barcode_scanner/static/description/index.html @@ -0,0 +1,500 @@ + + + + + +Barcode Scanner + + + +
+ + + +Odoo Community Association + +
+

Barcode Scanner

+ +

Beta License: AGPL-3 OCA/barcode-interface Translate me on Weblate Try me on Runboat

+

This module is the base framework of the Barcode suite: a fast, +full-screen scanning application shell for Odoo that other modules +extend.

+

It ships no business logic of its own. Instead it exposes the building +blocks feature modules plug into, the same way Odoo widgets +self-register:

+
    +
  • a full-screen client action and a lightweight in-app router;
    • +
  • registries for screens, scan handlers and home-screen menu tiles +(barcode_screens, barcode_scan_handlers, +barcode_menu_tiles);
    • +
  • the barcode input service (hardware/keyboard wedge), audio/vibration +feedback, an ORM/API wrapper and shared hooks.
    • +
+

Install a feature module on top — such as barcode_stock — to get +actual warehouse operations.

+

Table of contents

+ +
+

Usage

+

barcode_scanner is a framework and is not useful on its own: install +a feature module such as barcode_stock to get actual operations.

+

To build your own feature module, register your pieces into the +framework registries — no change to the base module is required.

+

Register a screen:

+
+import {barcodeScreens} from "@barcode_scanner/js/registries";
+
+barcodeScreens.add("my_screen", {component: MyScreen});
+
+

Register a scan handler (tried in sequence order; the first that +returns a truthy value consumes the scan):

+
+import {barcodeScanHandlers} from "@barcode_scanner/js/registries";
+
+barcodeScanHandlers.add("my_handler", {
+    async handle(barcode, parsed, {api, navigate, notify}) {
+        // return true when handled
+    },
+}, {sequence: 50});
+
+

Register a home-screen tile:

+
+import {barcodeMenuTiles} from "@barcode_scanner/js/registries";
+
+barcodeMenuTiles.add("my_tile", {
+    label: "My Screen",
+    icon: "fa-cube",
+    action: ({navigate}) => navigate("my_screen"),
+}, {sequence: 50});
+
+

Register a barcode parser (tried in sequence order before the +built-in EAN13 one; return null to let the next parser try):

+
+import {barcodeParsers} from "@barcode_scanner/js/registries";
+
+barcodeParsers.add("my_symbology", (barcode) => {
+    // return {type: "...", value: "<product code>", ...} or null
+}, {sequence: 20});
+
+

Register a startup task, for data your module needs before the first +scan (barcode_gs1 reads its nomenclature this way). Tasks are +awaited when the app opens; one that fails is logged and skipped:

+
+import {barcodeStartupTasks} from "@barcode_scanner/js/registries";
+
+barcodeStartupTasks.add("my_config", (env) => loadMyConfig(env.services.orm));
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Binhex
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

szalatyzuzanna

+

This module is part of the OCA/barcode-interface project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/barcode_scanner/static/src/img/icon_barcode.svg b/barcode_scanner/static/src/img/icon_barcode.svg new file mode 100644 index 0000000..62b0945 --- /dev/null +++ b/barcode_scanner/static/src/img/icon_barcode.svg @@ -0,0 +1,65 @@ + + diff --git a/barcode_scanner/static/src/js/api.esm.js b/barcode_scanner/static/src/js/api.esm.js new file mode 100644 index 0000000..b4c18be --- /dev/null +++ b/barcode_scanner/static/src/js/api.esm.js @@ -0,0 +1,133 @@ +import {registry} from "@web/core/registry"; +import {_t} from "@web/core/l10n/translation"; + +// Server exceptions whose message is safe to show to operators. Anything +// else (real internal errors) falls back to a generic message so the PDA +// never displays raw Python tracebacks (which the RPC layer puts in +// error.data.debug, never read here). +// MissingError is included because the record is gone (operator can reload). +// AccessDenied is excluded because it signals authentication/session failure +// (generic message plus login flow, no raw detail). +const USER_ERROR_NAMES = new Set([ + "odoo.exceptions.UserError", + "odoo.exceptions.ValidationError", + "odoo.exceptions.AccessError", + "odoo.exceptions.MissingError", +]); + +export function errorMessage(error, fallback) { + const message = error?.data?.message; + return USER_ERROR_NAMES.has(error?.data?.name) && + typeof message === "string" && + message + ? message + : fallback; +} + +export const barcodeApiService = { + dependencies: ["orm", "notification", "dialog"], + start(env, {orm, notification, dialog}) { + return { + async call(model, method, args = [], kwargs = {}) { + try { + return await orm.call(model, method, args, kwargs); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while calling the server.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async searchRead(model, domain, fields, options = {}) { + try { + return await orm.searchRead(model, domain, fields, options); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while fetching data.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async readGroup(model, domain, fields, groupby, options = {}) { + try { + return await orm.readGroup(model, domain, fields, groupby, options); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while grouping data.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async read(model, ids, fields) { + try { + return await orm.read(model, ids, fields); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while reading records.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async write(model, ids, data) { + try { + return await orm.write(model, ids, data); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while saving records.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async create(model, data) { + try { + return await orm.create(model, data); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while creating records.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + async unlink(model, ids) { + try { + return await orm.unlink(model, ids); + } catch (error) { + const message = errorMessage( + error, + _t("An error occurred while deleting records.") + ); + notification.add(message, {type: "danger"}); + throw error; + } + }, + + notify(message, options = {}) { + notification.add(message, options); + }, + + openDialog(dialogClass, props = {}) { + dialog.add(dialogClass, props); + }, + }; + }, +}; + +registry.category("services").add("barcodeApi", barcodeApiService); diff --git a/barcode_scanner/static/src/js/app.esm.js b/barcode_scanner/static/src/js/app.esm.js new file mode 100644 index 0000000..2a4467b --- /dev/null +++ b/barcode_scanner/static/src/js/app.esm.js @@ -0,0 +1,66 @@ +import {Component, onMounted, onWillStart, onWillUnmount, useState} from "@odoo/owl"; +import {registry} from "@web/core/registry"; +import {useService} from "@web/core/utils/hooks"; + +import "@barcode_scanner/js/services/feedback_service.esm"; + +import { + barcodeAppWidgets, + barcodeScreens, + barcodeStartupTasks, +} from "@barcode_scanner/js/registries.esm"; + +export class BarcodeScannerApp extends Component { + setup() { + this.barcode = useService("barcodeScannerBarcode"); + this.feedback = useState(useService("barcodeScannerFeedback")); + this.dialog = useService("dialog"); + this.router = useState(useService("barcodeRouter")); + if (!this.router.currentRoute) { + this.router.navigate("main"); + } + onWillStart(() => this.runStartupTasks()); + // Capture scans (incl. Android IME/soft-input PDAs) only while the app + // is open, so it never steals focus on the rest of the back office. + onMounted(() => this.barcode.activate()); + onWillUnmount(() => this.barcode.deactivate()); + } + + /** + * Let the installed feature modules warm up before the first scan. One + * failing task (a missing record, no access) must not keep the app closed, + * so each is caught on its own. + */ + async runStartupTasks() { + await Promise.all( + barcodeStartupTasks.getAll().map(async (task) => { + try { + await task(this.env); + } catch (error) { + console.warn("Barcode: a startup task failed", error); + } + }) + ); + } + + get currentScreen() { + const name = this.router.currentRoute?.name; + return name ? barcodeScreens.get(name, null) : null; + } + + get currentScreenProps() { + const entry = this.currentScreen; + const params = this.router.routeParams || {}; + const navigate = this.router.navigate.bind(this.router); + const extra = entry && entry.props ? entry.props(params) : {params}; + return {navigate, ...extra}; + } + + get appWidgets() { + return barcodeAppWidgets.getAll(); + } +} + +BarcodeScannerApp.template = "barcode_scanner.App"; + +registry.category("actions").add("barcode_scanner_app", BarcodeScannerApp); diff --git a/barcode_scanner/static/src/js/barcode.esm.js b/barcode_scanner/static/src/js/barcode.esm.js new file mode 100644 index 0000000..6059a81 --- /dev/null +++ b/barcode_scanner/static/src/js/barcode.esm.js @@ -0,0 +1,408 @@ +import {EventBus} from "@odoo/owl"; +import {registry} from "@web/core/registry"; +import {session} from "@web/session"; +import {parseBarcode} from "@barcode_scanner/js/barcode_parser.esm"; + +/** + * Barcode capture for the scanning SPA, built for the Munbyn Android PDAs used + * by Donaldson and Spartan. + * + * These PDAs deliver every laser scan through the Android input method (IME), + * not as real key events: each keystroke arrives as `keydown key="Unidentified"` + * (keyCode 0/229) and the actual code is committed as TEXT into the focused + * field's `.value`. So we keep a hidden, focused and read the scan from + * its `.value` on the terminating Enter/Tab (or shortly after the bulk `input` + * event for scanners that send no Enter). + * + * The input must STAY a plain editable field: anything that hides the Android + * soft keyboard for good -- `inputmode="none"` OR the VirtualKeyboard API -- + * also closes the IME composition session on this hardware, after which the + * scanner reads only once per Chrome session (proven on-device, see the + * barcode-pda-scanner-ime-only note). To keep the laser reading on every screen + * without the soft keyboard popping up, we focus() the field while it is + * briefly `readonly` and restore it to editable right after: a readonly field + * never raises the soft keyboard on Android Chrome, yet it stays focused and + * connected to the IME the whole time. Flip HIDE_SOFT_KEYBOARD below to false + * if a PDA stops reading after the first scan (its IME only injects while the + * keyboard is actually up). + * + * A permanent on-screen "scan feedback" toast shows the full code the PDA just + * read, then fades, so a misread or a dead scan is visible instead of silent. + */ + +// GS1 FNC1 group separator (the real control char the parser splits on). +const GS1_FNC1 = String.fromCharCode(29); + +// Scanners / the Android IME sometimes deliver the FNC1 separator not as the +// real 0x1D control char but as its visible Unicode symbol (U+241D), a nearby +// separator symbol, or a replacement box (U+FFFD). Normalise all back to 0x1D so +// the GS1 parser detects the barcode as GS1 and splits the AIs. +const GS1_SEPARATOR_VARIANTS = /[␝␞␟�]/g; +function normalizeGs1Separators(str) { + return str.replace(GS1_SEPARATOR_VARIANTS, GS1_FNC1); +} + +// For the on-screen feedback: render control chars (incl. the GS1 separator), +// the "control pictures" block and the replacement box as a visible middot, so +// the whole scanned code stays readable. +const NON_PRINTABLE = /[\x00-\x1f\x7f␀-␿�]/g; + +function isEditable(element) { + if (!element || element.nodeType !== 1) { + return false; + } + return ( + element.matches('input, textarea, select, [contenteditable="true"]') || + element.isContentEditable + ); +} + +// Real interactive targets the user is deliberately operating: we must not steal +// focus from these, so their own keyboard shows and they can type -- and native +// pop-ups (a