@monitordog/detector 1.0.0 → 1.0.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.
Files changed (2) hide show
  1. package/README.md +8 -26
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -80,45 +80,27 @@ export async function POST(request: Request) {
80
80
  }
81
81
  ```
82
82
 
83
- ## Public Runtime Calls
83
+ ## Network Access
84
84
 
85
- Across `login({ email })` and `start()`, the SDK runtime is expected to call only these MonitorDog API paths:
85
+ Your backend issues short-lived SDK tokens through `POST /v1/sdk/sessions`.
86
+ The browser SDK uses `apiBaseUrl` to load MonitorDog runtime resources, fetch
87
+ account policy, upload evidence images, and send detection events.
86
88
 
87
- - `GET /account/me`
88
- - `GET /account/{uuid}/lock_policy`
89
- - `GET /auth/sdk-model`
90
- - `POST /file/image`
91
- - `POST /event`
92
-
93
- The browser SDK does not call password login, MFA, refresh-token, cookie-refresh, remote stream, remote unlock, or policy update APIs.
89
+ Do not call `/v1/sdk/sessions` directly from browser code because it requires
90
+ your MonitorDog partner API key.
94
91
 
95
92
  ## Public API
96
93
 
97
- The package entry is `src/index.ts`; generated declarations are copied to `dist/monitordog-detector.d.ts`.
98
-
99
- Official customer entrypoint:
100
-
101
- - `MonitorDogDetector.init(options)`
102
-
103
- Compatibility exports for older integrations:
104
-
105
- - `configureMonitorDogDetector(options)`
106
- - `createMonitorDogDetector(options)`
107
- - `getDetector()`
94
+ Use `MonitorDogDetector.init(options)` to create the detector.
108
95
 
109
- Detector methods:
96
+ Common detector methods:
110
97
 
111
98
  - `login({ email })`
112
- - `load()`
113
99
  - `start()`
114
100
  - `stop()`
115
101
  - `logout()`
116
102
  - `dispose()`
117
103
  - `getState()`
118
- - `setRunInBackground(runInBackground)`
119
- - `getUserPreferences()`
120
- - `isMainUserTrackingEnabled()`
121
- - `setMainUserTrackingEnabled(enabled)`
122
104
 
123
105
  Default lifecycle:
124
106
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@monitordog/detector",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "type": "module",
5
5
  "description": "Browser SDK for running the bundled MonitorDog ONNX detector.",
6
6
  "license": "SEE LICENSE IN LICENSE",