@simprints/simface-sdk 0.16.1 → 0.20.1
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 +3 -5
- package/dist/index.d.ts +4 -2
- package/dist/index.js +4 -2
- package/dist/index.js.map +1 -1
- package/dist/services/api-client.js +2 -1
- package/dist/services/api-client.js.map +1 -1
- package/dist/shared/api-url.d.ts +2 -0
- package/dist/shared/api-url.js +9 -0
- package/dist/shared/api-url.js.map +1 -0
- package/dist/simface-sdk.js +817 -813
- package/dist/simface-sdk.umd.cjs +26 -26
- package/dist/types/index.d.ts +2 -2
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -52,7 +52,6 @@ The release contains two builds:
|
|
|
52
52
|
|
|
53
53
|
```javascript
|
|
54
54
|
const config = {
|
|
55
|
-
apiUrl: 'https://your-simface-api.run.app',
|
|
56
55
|
projectId: 'your-project-id',
|
|
57
56
|
apiKey: 'your-api-key',
|
|
58
57
|
};
|
|
@@ -175,7 +174,7 @@ Parameters:
|
|
|
175
174
|
|
|
176
175
|
| Parameter | Type | Description |
|
|
177
176
|
|-----------|------|-------------|
|
|
178
|
-
| `config` | `SimFaceConfig` | SDK configuration (`
|
|
177
|
+
| `config` | `SimFaceConfig` | SDK configuration (`projectId`, `apiKey`, optional `apiUrl`) |
|
|
179
178
|
| `clientId` | `string` | Unique identifier for the user |
|
|
180
179
|
| `workflowOptions` | `SimFaceWorkflowOptions` | Optional popup/embedded-agnostic capture behavior |
|
|
181
180
|
| `captureElement` | `SimFaceCaptureElement` | Optional embedded `simface-capture` element |
|
|
@@ -190,7 +189,7 @@ Parameters:
|
|
|
190
189
|
|
|
191
190
|
| Parameter | Type | Description |
|
|
192
191
|
|-----------|------|-------------|
|
|
193
|
-
| `config` | `SimFaceConfig` | SDK configuration (`
|
|
192
|
+
| `config` | `SimFaceConfig` | SDK configuration (`projectId`, `apiKey`, optional `apiUrl`) |
|
|
194
193
|
| `clientId` | `string` | Unique identifier for the user |
|
|
195
194
|
| `workflowOptions` | `SimFaceWorkflowOptions` | Optional popup/embedded-agnostic capture behavior |
|
|
196
195
|
| `captureElement` | `SimFaceCaptureElement` | Optional embedded `simface-capture` element |
|
|
@@ -237,7 +236,6 @@ Use the `simface-capture` Web Component directly when you want the host applicat
|
|
|
237
236
|
|
|
238
237
|
const captureEl = document.querySelector('simface-capture');
|
|
239
238
|
const client = new SimFaceAPIClient({
|
|
240
|
-
apiUrl: 'https://your-simface-api.run.app',
|
|
241
239
|
projectId: 'your-project-id',
|
|
242
240
|
apiKey: 'your-api-key',
|
|
243
241
|
});
|
|
@@ -296,9 +294,9 @@ This is more flexible, but it also means the host owns more of the workflow.
|
|
|
296
294
|
|
|
297
295
|
```typescript
|
|
298
296
|
interface SimFaceConfig {
|
|
299
|
-
apiUrl: string;
|
|
300
297
|
projectId: string;
|
|
301
298
|
apiKey: string;
|
|
299
|
+
apiUrl?: string; // Defaults to the hosted SimFace backend
|
|
302
300
|
}
|
|
303
301
|
```
|
|
304
302
|
|
package/dist/index.d.ts
CHANGED
|
@@ -4,11 +4,13 @@
|
|
|
4
4
|
* Usage:
|
|
5
5
|
* import { enroll, verify } from '@simprints/simface-sdk';
|
|
6
6
|
*
|
|
7
|
+
* const config = { projectId: '...', apiKey: '...' };
|
|
8
|
+
*
|
|
7
9
|
* // Enroll a new user
|
|
8
|
-
* const result = await enroll(
|
|
10
|
+
* const result = await enroll(config, 'user-123');
|
|
9
11
|
*
|
|
10
12
|
* // Verify an existing user
|
|
11
|
-
* const result = await verify(
|
|
13
|
+
* const result = await verify(config, 'user-123');
|
|
12
14
|
*/
|
|
13
15
|
import type { SimFaceCaptureElement, SimFaceWorkflowOptions, SimFaceConfig, EnrollResult, VerifyResult } from './types/index.js';
|
|
14
16
|
export type { CapturePreference, SimFaceCaptureElement, SimFaceWorkflowOptions, SimFaceConfig, EnrollResult, VerifyResult, FaceQualityResult, ValidateResult, } from './types/index.js';
|
package/dist/index.js
CHANGED
|
@@ -4,11 +4,13 @@
|
|
|
4
4
|
* Usage:
|
|
5
5
|
* import { enroll, verify } from '@simprints/simface-sdk';
|
|
6
6
|
*
|
|
7
|
+
* const config = { projectId: '...', apiKey: '...' };
|
|
8
|
+
*
|
|
7
9
|
* // Enroll a new user
|
|
8
|
-
* const result = await enroll(
|
|
10
|
+
* const result = await enroll(config, 'user-123');
|
|
9
11
|
*
|
|
10
12
|
* // Verify an existing user
|
|
11
|
-
* const result = await verify(
|
|
13
|
+
* const result = await verify(config, 'user-123');
|
|
12
14
|
*/
|
|
13
15
|
import { SimFaceAPIClient } from './services/api-client.js';
|
|
14
16
|
import { captureFromCamera } from './services/camera.js';
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AASH,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAazD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,MAAM,8BAA8B,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,MAAqB,EACrB,QAAgB,EAChB,eAAwC,EACxC,cAAsC;IAEtC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE5C,yBAAyB;IACzB,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC;IAE9B,qBAAqB;IACrB,MAAM,IAAI,GAAG,MAAM,uBAAuB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC5E,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC;IAC5E,CAAC;IAED,kBAAkB;IAClB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAEnD,+CAA+C;IAC/C,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,MAAqB,EACrB,QAAgB,EAChB,eAAwC,EACxC,cAAsC;IAEtC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE5C,yBAAyB;IACzB,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC;IAE9B,qBAAqB;IACrB,MAAM,IAAI,GAAG,MAAM,uBAAuB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;IAC5E,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,2BAA2B,EAAE,CAAC;IACxF,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,uBAAuB,CACpC,eAAwC,EACxC,cAAsC;IAEtC,OAAO,iBAAiB,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC;AAC5D,CAAC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { resolveApiUrl } from '../shared/api-url.js';
|
|
1
2
|
async function getAPIErrorMessage(response, fallback) {
|
|
2
3
|
try {
|
|
3
4
|
const err = await response.json();
|
|
@@ -12,7 +13,7 @@ async function getAPIErrorMessage(response, fallback) {
|
|
|
12
13
|
}
|
|
13
14
|
export class SimFaceAPIClient {
|
|
14
15
|
constructor(config) {
|
|
15
|
-
this.apiUrl = config.apiUrl
|
|
16
|
+
this.apiUrl = resolveApiUrl(config.apiUrl);
|
|
16
17
|
this.projectId = config.projectId;
|
|
17
18
|
this.apiKey = config.apiKey;
|
|
18
19
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../../src/services/api-client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../../src/services/api-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAErD,KAAK,UAAU,kBAAkB,CAAC,QAAkB,EAAE,QAAgB;IACpE,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAuB,CAAC;QACvD,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YACtD,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,8EAA8E;IAChF,CAAC;IAED,OAAO,GAAG,QAAQ,UAAU,QAAQ,CAAC,MAAM,GAAG,CAAC;AACjD,CAAC;AAED,MAAM,OAAO,gBAAgB;IAK3B,YAAY,MAAqB;QAC/B,IAAI,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,uBAAuB,EAAE;YAClE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE;YAC/C,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,MAAM,kBAAkB,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC,CAAC;QACnF,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,SAAe;QAC5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,gBAAgB,EAAE;YAC3D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,OAAO,EAAE,uBAAuB,EAAE,CAAC;QAC/F,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,MAAM,kBAAkB,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,SAAe;QAC5C,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;QAChC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,QAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACvC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACtC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,gBAAgB,EAAE;YAC3D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;QACnG,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,MAAM,kBAAkB,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC,CAAC;QAC7E,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;CACF"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export const DEFAULT_SIMFACE_API_URL = 'https://simface-api-85584555549.europe-west1.run.app';
|
|
2
|
+
export function resolveApiUrl(apiUrl) {
|
|
3
|
+
if (typeof apiUrl !== 'string') {
|
|
4
|
+
return DEFAULT_SIMFACE_API_URL;
|
|
5
|
+
}
|
|
6
|
+
const normalizedApiUrl = apiUrl.trim().replace(/\/$/, '');
|
|
7
|
+
return normalizedApiUrl || DEFAULT_SIMFACE_API_URL;
|
|
8
|
+
}
|
|
9
|
+
//# sourceMappingURL=api-url.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-url.js","sourceRoot":"","sources":["../../src/shared/api-url.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,uBAAuB,GAAG,sDAAsD,CAAC;AAE9F,MAAM,UAAU,aAAa,CAAC,MAAe;IAC3C,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAC1D,OAAO,gBAAgB,IAAI,uBAAuB,CAAC;AACrD,CAAC"}
|