alphavalid-sdk 0.0.6 → 0.0.9
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 +73 -0
- package/dist/alphavalid.es.js +1 -1
- package/dist/alphavalid.umd.js +1 -1
- package/models/README.md +8 -0
- package/models/tiny_face_detector_model-shard1 +0 -0
- package/models/tiny_face_detector_model-weights_manifest.json +1 -0
- package/package.json +11 -2
- package/.gitattributes +0 -2
- package/dist/core/camera.d.ts +0 -8
- package/dist/core/camera.d.ts.map +0 -1
- package/dist/core/feedback.d.ts +0 -7
- package/dist/core/feedback.d.ts.map +0 -1
- package/dist/index.d.ts +0 -17
- package/dist/index.d.ts.map +0 -1
- package/dist/types/sdk.d.ts +0 -29
- package/dist/types/sdk.d.ts.map +0 -1
- package/dist/ui/overlay.d.ts +0 -16
- package/dist/ui/overlay.d.ts.map +0 -1
- package/dist/utils/dom.d.ts +0 -3
- package/dist/utils/dom.d.ts.map +0 -1
- package/dist/vision/faceDetector.d.ts +0 -7
- package/dist/vision/faceDetector.d.ts.map +0 -1
- package/src/core/camera.ts +0 -69
- package/src/core/feedback.ts +0 -37
- package/src/index.ts +0 -120
- package/src/types/sdk.ts +0 -40
- package/src/ui/overlay.ts +0 -93
- package/src/utils/dom.ts +0 -14
- package/src/vision/faceDetector.ts +0 -49
package/README.md
CHANGED
|
@@ -1,2 +1,75 @@
|
|
|
1
1
|
# alphavalid-sdk
|
|
2
2
|
|
|
3
|
+
SDK frontend (framework-agnostic) para:
|
|
4
|
+
- abrir câmera frontal
|
|
5
|
+
- guiar posicionamento (overlay)
|
|
6
|
+
- detectar rosto (MVP) com `face-api.js` (TinyFaceDetector)
|
|
7
|
+
- capturar selfie em JPEG (Blob)
|
|
8
|
+
|
|
9
|
+
## Instalação
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm i alphavalid-sdk
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Passo obrigatório: disponibilizar os models
|
|
16
|
+
|
|
17
|
+
O `face-api.js` carrega os pesos do modelo via HTTP. Este pacote leva os arquivos em `models/`, e você deve copiá-los para os assets do seu app.
|
|
18
|
+
|
|
19
|
+
### Ionic/Angular (recomendado) — cópia automática no `postinstall`
|
|
20
|
+
|
|
21
|
+
No `package.json` do **APP consumidor**, adicione:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"scripts": {
|
|
26
|
+
"postinstall": "node ./node_modules/alphavalid-sdk/scripts/copy-models.cjs ./src/assets/alphavalid-models"
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Isso garante que, ao rodar `npm i`, os models sejam copiados para:
|
|
32
|
+
|
|
33
|
+
- `src/assets/alphavalid-models/` -> servidos em runtime como `/assets/alphavalid-models`
|
|
34
|
+
|
|
35
|
+
> Se você estiver no Windows, pode precisar rodar esse script via `node` do mesmo jeito (sem `./`).
|
|
36
|
+
|
|
37
|
+
### Execução manual (alternativa)
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
node ./node_modules/alphavalid-sdk/scripts/copy-models.cjs ./src/assets/alphavalid-models
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Uso
|
|
44
|
+
|
|
45
|
+
Crie um container (div) com tamanho definido (ex.: 320x320, ou 100% do seu layout) e passe no `start()`.
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
import { AlphaValid } from 'alphavalid-sdk';
|
|
49
|
+
|
|
50
|
+
const sdk = new AlphaValid();
|
|
51
|
+
|
|
52
|
+
await sdk.start({
|
|
53
|
+
container: document.getElementById('cameraContainer')!,
|
|
54
|
+
// default: '/assets/alphavalid-models'
|
|
55
|
+
// modelsPath: '/assets/alphavalid-models',
|
|
56
|
+
onReady: () => console.log('ready'),
|
|
57
|
+
onFeedback: (msg) => console.log('feedback:', msg),
|
|
58
|
+
onError: (err) => console.error('error:', err)
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
// quando feedback retornar "Pronto para capturar"
|
|
62
|
+
const blob = await sdk.capture();
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Para encerrar:
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
await sdk.stop();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Observações
|
|
72
|
+
|
|
73
|
+
- Este MVP faz **detecção** (tem 1 rosto? está centralizado? perto/longe?).
|
|
74
|
+
- Não é reconhecimento facial (comparar com base de rostos).
|
|
75
|
+
|
package/dist/alphavalid.es.js
CHANGED
|
@@ -17984,7 +17984,7 @@ var h_ = class {
|
|
|
17984
17984
|
overlay: !0,
|
|
17985
17985
|
guideCircleRatio: .72,
|
|
17986
17986
|
detectionIntervalMs: 200,
|
|
17987
|
-
modelsPath: "/models",
|
|
17987
|
+
modelsPath: "/alphavalid-models",
|
|
17988
17988
|
...e
|
|
17989
17989
|
}, this._container = this._options.container;
|
|
17990
17990
|
try {
|