@reset-framework/sdk 0.2.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.
- package/README.md +27 -2
- package/package.json +6 -2
- package/src/client.js +634 -31
- package/src/errors.js +30 -3
- package/src/events.js +123 -0
- package/src/index.d.ts +497 -13
- package/src/index.js +32 -2
- package/src/transport.js +180 -0
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Responsibilities:
|
|
6
6
|
|
|
7
|
-
- expose a stable
|
|
7
|
+
- expose a stable typed client for app frontends
|
|
8
8
|
- hide the raw `window.reset` bridge envelope
|
|
9
9
|
- provide runtime availability checks for local browser development
|
|
10
10
|
- centralize the shared browser helpers used by templates and demo apps
|
|
@@ -12,5 +12,30 @@ Responsibilities:
|
|
|
12
12
|
Package layout:
|
|
13
13
|
|
|
14
14
|
- `src/index.js`: public entrypoint
|
|
15
|
-
- `src/client.js`:
|
|
15
|
+
- `src/client.js`: high-level client and namespaced APIs
|
|
16
|
+
- `src/transport.js`: low-level transport and response validation
|
|
16
17
|
- `src/errors.js`: SDK-specific error types
|
|
18
|
+
|
|
19
|
+
Recommended usage:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { reset } from "@reset-framework/sdk"
|
|
23
|
+
|
|
24
|
+
const appInfo = await reset.app.getInfo()
|
|
25
|
+
const runtimeInfo = await reset.runtime.getInfo()
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Available namespaces:
|
|
29
|
+
|
|
30
|
+
- `reset.app.getId()`
|
|
31
|
+
- `reset.app.getName()`
|
|
32
|
+
- `reset.app.getSlug()`
|
|
33
|
+
- `reset.app.getVersion()`
|
|
34
|
+
- `reset.app.getInfo()`
|
|
35
|
+
- `reset.runtime.getPlatform()`
|
|
36
|
+
- `reset.runtime.getArchitecture()`
|
|
37
|
+
- `reset.runtime.getFrameworkVersion()`
|
|
38
|
+
- `reset.runtime.getBridgeVersion()`
|
|
39
|
+
- `reset.runtime.getInfo()`
|
|
40
|
+
- `reset.commands.invoke()`
|
|
41
|
+
- `reset.commands.invokeRaw()`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reset-framework/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Browser-side SDK for Reset Framework applications.",
|
|
6
6
|
"license": "MIT",
|
|
@@ -10,7 +10,11 @@
|
|
|
10
10
|
"sideEffects": false,
|
|
11
11
|
"types": "./src/index.d.ts",
|
|
12
12
|
"exports": {
|
|
13
|
-
".":
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./src/index.d.ts",
|
|
15
|
+
"import": "./src/index.js",
|
|
16
|
+
"default": "./src/index.js"
|
|
17
|
+
},
|
|
14
18
|
"./package.json": "./package.json"
|
|
15
19
|
},
|
|
16
20
|
"files": [
|