@andresxid/xid_camera_ocr_sdk_react 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 0.1.0
+
+Initial release of `@andresxid/xid_camera_ocr_sdk_react`, forked from `@andresxid/extract-sdk-*` 0.4.0.
+
+### Added
+
+- Theming: 14 `--xco-*` CSS variables through the `theme` prop, and exported `XCO_VARS`.
+- Texts: per-key `texts` prop with es-MX defaults (`DEFAULT_TEXTS_ES`) and `DEFAULT_TEXTS_EN`.
+- Tips card (`showTips`, default on) shown during `starting`/`loading_detector` before the first completed capture, hidden on `streaming`, dismissible with its button, and shown again on every `error` even if dismissed earlier.
+- Zero-config Vite 5.4+, 6 and 7 (no `optimizeDeps` or `worker` setting), proven by the packed-tarball consumer matrix.
+- `workerUrl` option (with `opencvUrl`) so CJS and non-Vite consumers can self-host `cv-worker.js` and `opencv.js`.
+- Full demo (`examples/full-demo`) with a laboratorio signing backend.
+
+### Removed
+
+- The deprecated 0.4.0 APIs: `useOpenCV`, `detectDocument`, `classifyByAspect`, `assessQuality`, `CVWorkerClient.detect`.
+- The Vue wrapper.
+
+### Changed
+
+- Renamed the public names: `<XidCameraOcr />`, `useXidCameraOcr()`, `XidCameraOcrSession`, `XidCameraOcrSessionOptions`, root class `xid-camera-ocr`, inner classes `xco-*`, keyframes `xco-spin`.
+- Vendored OpenCV needs `'unsafe-eval'` in the CSP (see README).

package/README.md

@@ -0,0 +1,223 @@
+# @andresxid/xid_camera_ocr_sdk_react
+
+React component and headless hook that capture an identity document in the browser: camera, on-device OpenCV edge detection, quality checks and an auto-shutter. It returns a rectified JPEG to your `onUpload` callback and knows nothing about your backend.
+
+## Install
+
+The package is published as restricted. Add a token to your project `.npmrc` (keep the real token in the `NPM_TOKEN` environment variable, never in the file):
+
+```
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}
+```
+
+```bash
+pnpm add @andresxid/xid_camera_ocr_sdk_react
+```
+
+Peer dependencies: `react >=18` and `react-dom >=18`. There are no runtime dependencies. The library supports Node >= 18 (the full demo and the Vite consumer harness need Node >= 20.19 because they run Vite 7).
+
+## Usage
+
+```tsx
+import { XidCameraOcr } from '@andresxid/xid_camera_ocr_sdk_react';
+
+export function Capture() {
+  return (
+    <XidCameraOcr
+      onUpload={async (blob, detectedType) => {
+        const form = new FormData();
+        form.append('document', blob, 'capture.jpg');
+        const res = await fetch('/api/extract', { method: 'POST', body: form });
+        if (!res.ok) throw new Error(`Upload failed: HTTP ${res.status}`);
+        return res.json();
+      }}
+      onResult={(result) => console.log(result)}
+      onError={(err) => console.error(err)}
+    />
+  );
+}
+```
+
+`onUpload` receives the rectified JPEG `Blob` and a shape hint (`'INE' | 'PASSPORT_MX' | 'OTHER' | null`). It must return the backend JSON. The hint is a card shape, not a document-type claim: your backend decides the real type.
+
+Need your own UI? `useXidCameraOcr(options)` is the headless hook. It returns `videoRef`, `status`, `frame`, `result`, `error`, `start`, `stop`, `captureNow` and `retake`; attach `videoRef` to a `<video playsInline muted>` and render whatever you like. `XidCameraOcrSession` is the framework-free class underneath both.
+
+## Backend pattern
+
+The browser never holds a credential. It posts the JPEG to **your** backend, and your backend signs and forwards the request as `multipart/form-data` with the file in the `document` field:
+
+```
+POST /v1/documents/extract
+Authorization: Bearer mvk_<KEY_ID>
+X-Xid-Timestamp: <ISO-8601 UTC, e.g. 2026-10-29T18:04:05.123Z>
+X-Xid-Signature: <base64 Ed25519 signature>
+Origin: <your allowed origin>
+```
+
+- The signed message is the canonical string `${METHOD}\n${PATH}\n${TIMESTAMP}` (for example `POST\n/v1/documents/extract\n2026-10-29T18:04:05.123Z`). The body is not signed.
+- The timestamp must be within 5 minutes of the server clock.
+- The secret key is a 32-byte Ed25519 seed, base64-encoded. Keep it on the server only (an environment variable, never in the browser bundle).
+
+A minimal Node signer (Node >= 18, no dependencies):
+
+```js
+import { createPrivateKey, sign } from 'node:crypto';
+
+const PKCS8_ED25519_PREFIX = Buffer.from('302e020100300506032b657004220420', 'hex');
+const seed = Buffer.from(process.env.SECRET_KEY_B64, 'base64'); // 32 bytes
+const privateKey = createPrivateKey({ key: Buffer.concat([PKCS8_ED25519_PREFIX, seed]), format: 'der', type: 'pkcs8' });
+
+export function signedHeaders(method, path, { keyId, origin }) {
+  const ts = new Date().toISOString();
+  const signature = sign(null, Buffer.from(`${method}\n${path}\n${ts}`), privateKey);
+  return {
+    Authorization: `Bearer mvk_${keyId}`,
+    'X-Xid-Timestamp': ts,
+    'X-Xid-Signature': signature.toString('base64'),
+    Origin: origin,
+  };
+}
+```
+
+Forward the browser's file with these headers (`form` is a `FormData` holding the JPEG under `document`):
+
+```js
+const path = '/v1/documents/extract';
+const upstream = await fetch(`${XID_ENDPOINT}${path}`, {
+  method: 'POST',
+  headers: signedHeaders('POST', path, { keyId: KEY_ID, origin: ORIGIN }),
+  body: form,
+});
+```
+
+## Theming
+
+Pass a `theme` object. The component writes a `--xco-*` custom property to its root only for the keys you set; everything else uses the default below. You can also set the variables from plain CSS on any ancestor.
+
+```tsx
+<XidCameraOcr theme={{ accent: '#0057ff', radius: '20px', fontFamily: 'Inter, sans-serif' }} onUpload={upload} />
+```
+
+| Variable | Default | Used by |
+|---|---|---|
+| `--xco-accent` | `#22c55e` | Detected-and-ready outline, spinner arc |
+| `--xco-warning` | `#eab308` | Outline while the frame is detected but not yet stable |
+| `--xco-danger` | `#ef4444` | Outline with no document, and on error |
+| `--xco-background` | `#000` | Camera container background |
+| `--xco-mask` | `rgba(0,0,0,0.4)` | Dim area outside the guide |
+| `--xco-hint-bg` | `rgba(0,0,0,0.7)` | Hint banner background |
+| `--xco-hint-fg` | `white` | Hint banner text |
+| `--xco-button-bg` | `rgba(255,255,255,0.92)` | Retake button and tips dismiss button background |
+| `--xco-button-fg` | `#111` | Retake and dismiss button text |
+| `--xco-shutter` | `rgba(255,255,255,0.9)` | Shutter ring |
+| `--xco-overlay-bg` | `rgba(0,0,0,0.78)` | Status overlay and tips card background |
+| `--xco-overlay-fg` | `white` | Status overlay and tips card text |
+| `--xco-font-family` | `system-ui, -apple-system, sans-serif` | All text |
+| `--xco-radius` | `12px` | Guide rectangle, hint banner, tips card and its dismiss button |
+
+`XCO_VARS` (the same table as data) and the `XidCameraOcrTheme` / `XcoThemeKey` types are exported. The retake button keeps a fixed 22px pill radius, and the shutter's inner disc, its translucent glass and the spinner track are fixed (solid or translucent white); they are not themable.
+
+The inner `xco-*` class names are an implementation detail and **not** a supported API; theme through the variables.
+
+## Texts
+
+Every visible string can be overridden per key with the `texts` prop (`Partial<HintCopy>`). Missing (or `null`/`undefined`) keys fall back to the es-MX default; an empty string is kept as given. For English start from the exported `DEFAULT_TEXTS_EN`:
+
+```tsx
+import { XidCameraOcr, DEFAULT_TEXTS_EN } from '@andresxid/xid_camera_ocr_sdk_react';
+
+<XidCameraOcr texts={DEFAULT_TEXTS_EN} onUpload={upload} />
+<XidCameraOcr texts={{ done: 'Captured!' }} onUpload={upload} />
+```
+
+| Key | Default (es-MX) |
+|---|---|
+| `idle` | Toca para activar la cámara |
+| `starting` | Abriendo la cámara… |
+| `loading_detector` | Preparando la cámara… |
+| `no_document` | Coloca tu identificación dentro del recuadro |
+| `too_small` | Acerca más tu identificación |
+| `too_dark` | Hay poca luz, busca un lugar más iluminado |
+| `glare` | Hay un reflejo, inclina un poco tu identificación |
+| `blurry` | Espera a que la cámara enfoque |
+| `hold_still` | No te muevas… |
+| `ready` | ¡Perfecto! No te muevas |
+| `capturing` | Tomando la foto… |
+| `uploading` | Revisando tu identificación… |
+| `done` | ¡Listo! |
+| `error` | Algo salió mal, inténtalo de nuevo |
+| `detector_unavailable` | Toma la foto con el botón blanco |
+| `retake` | Tomar otra vez |
+| `capture` | Tomar foto |
+| `tip_light` | Busca un lugar con buena luz |
+| `tip_glare` | Evita reflejos: no apuntes una lámpara directo a tu identificación |
+| `tip_focus` | Espera a que la cámara enfoque; la foto se toma sola |
+| `tips_dismiss` | Entendido |
+
+The tips card (`tip_light`, `tip_glare`, `tip_focus`, `tips_dismiss`) shows while the camera starts or the detector loads (`starting`, `loading_detector`) before the first completed capture, and hides once the status is `streaming`. The user can dismiss it with its button, but it returns on every `error` even if it was dismissed earlier. Hide it entirely with `showTips={false}`.
+
+## Options
+
+`XidCameraOcrProps` (the hook accepts the same options except the view props):
+
+| Prop | Type | Default | Notes |
+|---|---|---|---|
+| `onUpload` | `(blob, detectedType) => Promise<ExtractResult>` | required | Your backend call |
+| `onFrameAnalyzed` | `(state: FrameState) => void` | | Every analysed frame |
+| `onCaptured` | `(blob, detectedType) => void` | | Right after the shutter |
+| `onResult` | `(result) => void` | | After `onUpload` resolves |
+| `onError` | `(err: Error) => void` | | Camera, detector or upload failure |
+| `autoStart` | `boolean` | `true` | Start the stream on mount |
+| `autoCapture` | `boolean` | `true` | Auto-shutter on a stable, good frame |
+| `documentTypes` | `DocumentType[]` | `['INE', 'PASSPORT_MX']` | Sizes the fallback guide; does not filter detection |
+| `stableFramesRequired` | `number` | `10` | Stable frames before auto-capture |
+| `captureQuality` | `number` | `0.92` | JPEG quality, 0 to 1 |
+| `captureResolution` | `'standard' \| 'high'` | `'standard'` | Long side 1024 px or 1600 px |
+| `opencvUrl` | `string` | packaged `opencv.js` | Self-hosted `dist/opencv.js`; required with `workerUrl` for CJS and non-Vite bundlers (see Known limitations) |
+| `workerUrl` | `string` | packaged `cv-worker.js` | Self-hosted `dist/cv-worker.js`, spawned as a module worker; required with `opencvUrl` for CJS and non-Vite bundlers |
+| `theme` | `XidCameraOcrTheme` | `{}` | See Theming |
+| `texts` | `Partial<HintCopy>` | es-MX defaults | See Texts |
+| `showTips` | `boolean` | `true` | Tips card |
+| `hideStatusOverlay` | `boolean` | `false` | Hides everything drawn over the video: guide and detected outline, hint banner (including the tap-to-start button), shutter, retake button, loader and tips card |
+| `className`, `style` | | | On the root `xid-camera-ocr` element |
+
+## Status lifecycle
+
+`idle` -> `starting` -> `loading_detector` -> `streaming` -> `capturing` -> `uploading` -> `done` | `error`.
+
+- `stopped` is reached after `stop()`.
+- One capture per run: after `done` or `error`, `retake()` stops and restarts the run to arm the shutter again.
+- If OpenCV cannot load, the status stays `streaming` with the frame hint `detector_unavailable`: auto-capture is off but the manual shutter still works.
+
+## Vite
+
+Vite 5.4+, 6 and 7 work with a plain config: no `optimizeDeps`, `worker` or other SDK-specific setting. The worker and `opencv.js` are referenced by package-specifier asset URLs that Vite resolves in dev and in builds. This is verified by an automated Vite 5/6/7 consumer test in our CI tooling (pnpm Vite 5/6/7 dev and preview, npm Vite 7 dev and preview, and Vite 7 under the CSP below).
+
+## Content Security Policy
+
+The strict policy the automated consumer test runs under:
+
+```
+default-src 'self'; script-src 'self' 'unsafe-eval' 'wasm-unsafe-eval'; worker-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' blob:; connect-src 'self'
+```
+
+Why each directive:
+
+- `default-src 'self'`: the baseline; everything not listed below is same-origin only.
+- `script-src 'self' 'wasm-unsafe-eval'`: `wasm-unsafe-eval` lets OpenCV instantiate its WebAssembly.
+- `script-src ... 'unsafe-eval'`: the vendored `opencv.js` embind layer builds functions from strings at startup. Without it the detector fails to start and the hint becomes `detector_unavailable` (manual capture still works). Removing the need for it requires rebuilding OpenCV with `-sDYNAMIC_EXECUTION=0`.
+- `worker-src 'self'`: the detector runs in a module worker served from your origin (no `blob:` or `data:` workers).
+- `style-src 'self' 'unsafe-inline'`: the component injects inline keyframes; without it only the spinner animation stops.
+- `img-src 'self' blob:`: the component itself loads no images. `blob:` is only needed if your page previews the captured `Blob` with `URL.createObjectURL`; drop it otherwise.
+- `connect-src 'self'`: your upload endpoint on the same origin. Add your API origin here if it differs.
+
+## Known limitations
+
+- **Detection quality (0.4.0 gate not met).** The detector was inherited from 0.4.0 and has not been improved here. On the detection eval, hand-occlusion IoU is 0.492 against a 0.90 threshold and clutter IoU is 0.534 against 0.80. The false-positive rate is unmeasured. Keep the manual shutter reachable and treat auto-capture as a convenience, not a guarantee.
+- **Phone validation.** Phone validation (iOS Safari / Android Chrome) is in progress; results will be published in a later release.
+- **CJS build needs `workerUrl` and `opencvUrl`.** The CJS bundle resolves `import.meta.url` against the document, not the package. CJS consumers must serve `dist/cv-worker.js` and `dist/opencv.js` from their own origin (copy them from `node_modules/@andresxid/xid_camera_ocr_sdk_react/dist/`) and pass both URLs; otherwise the detector cannot start and only manual capture works. ESM consumers on Vite need nothing.
+- **Non-Vite bundlers are untested** (webpack, Rollup alone, esbuild, Next.js). Host `dist/cv-worker.js` and `dist/opencv.js` yourself and pass both `workerUrl` and `opencvUrl`; otherwise only manual capture works.
+
+## License
+
+UNLICENSED, proprietary to XID. The bundled OpenCV (`dist/opencv.js`) is Apache-2.0; its notices ship in `dist/LICENSE-OpenCV.txt` and `dist/NOTICE-OpenCV.txt`.

package/dist/LICENSE-OpenCV.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/NOTICE-OpenCV.txt

@@ -0,0 +1,43 @@
+opencv.js (opencv-core-imgproc.js) — third-party notice
+
+This file contains OpenCV 4.10.0 (https://github.com/opencv/opencv, tag 4.10.0,
+commit 71d3237a093b60a27601c20e9ee6c3e52154e8b1).
+Copyright (C) OpenCV contributors. Licensed under the Apache License, Version 2.0;
+the full licence text is in LICENSE-OpenCV.txt.
+
+Modified: this is a custom whitelist build, not an upstream release. Only the core and
+imgproc modules are compiled, and only the functions listed in the SDK's
+tools/opencv-build/opencv_js.config.py get JavaScript bindings. It was compiled to
+WebAssembly with Emscripten 3.1.64 by tools/opencv-build (build.sh / Dockerfile). The UMD
+wrapper was patched (`Module = {}` -> `var Module = {}`) so it is valid strict-mode ESM.
+
+Artifact: vendor/opencv-core-imgproc.js
+sha256:   a76095316514442b4b6a240c311ddaf535b6dfa07c547a7092dca7356f03e0de
+
+The build also links zlib 1.3.1, bundled by OpenCV as 3rdparty/zlib, under the zlib
+licence reproduced below.
+
+--- zlib licence (3rdparty/zlib/LICENSE at the same OpenCV commit) ---
+
+Copyright notice:
+
+ (C) 1995-2022 Jean-loup Gailly and Mark Adler
+
+  This software is provided 'as-is', without any express or implied
+  warranty.  In no event will the authors be held liable for any damages
+  arising from the use of this software.
+
+  Permission is granted to anyone to use this software for any purpose,
+  including commercial applications, and to alter it and redistribute it
+  freely, subject to the following restrictions:
+
+  1. The origin of this software must not be misrepresented; you must not
+     claim that you wrote the original software. If you use this software
+     in a product, an acknowledgment in the product documentation would be
+     appreciated but is not required.
+  2. Altered source versions must be plainly marked as such, and must not be
+     misrepresented as being the original software.
+  3. This notice may not be removed or altered from any source distribution.
+
+  Jean-loup Gailly        Mark Adler
+  jloup@gzip.org          madler@alumni.caltech.edu