@reset-framework/sdk 0.2.0
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/LICENSE +21 -0
- package/README.md +16 -0
- package/package.json +21 -0
- package/src/client.js +53 -0
- package/src/errors.js +6 -0
- package/src/index.d.ts +61 -0
- package/src/index.js +9 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jan Kordoš
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to do so, subject to the
|
|
10
|
+
following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# SDK
|
|
2
|
+
|
|
3
|
+
`@reset-framework/sdk` is the browser-side JavaScript package for Reset applications.
|
|
4
|
+
|
|
5
|
+
Responsibilities:
|
|
6
|
+
|
|
7
|
+
- expose a stable `invoke()` API for app frontends
|
|
8
|
+
- hide the raw `window.reset` bridge envelope
|
|
9
|
+
- provide runtime availability checks for local browser development
|
|
10
|
+
- centralize the shared browser helpers used by templates and demo apps
|
|
11
|
+
|
|
12
|
+
Package layout:
|
|
13
|
+
|
|
14
|
+
- `src/index.js`: public entrypoint
|
|
15
|
+
- `src/client.js`: runtime bridge helpers
|
|
16
|
+
- `src/errors.js`: SDK-specific error types
|
package/package.json
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@reset-framework/sdk",
|
|
3
|
+
"version": "0.2.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "Browser-side SDK for Reset Framework applications.",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public"
|
|
9
|
+
},
|
|
10
|
+
"sideEffects": false,
|
|
11
|
+
"types": "./src/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": "./src/index.js",
|
|
14
|
+
"./package.json": "./package.json"
|
|
15
|
+
},
|
|
16
|
+
"files": [
|
|
17
|
+
"src",
|
|
18
|
+
"README.md",
|
|
19
|
+
"LICENSE"
|
|
20
|
+
]
|
|
21
|
+
}
|
package/src/client.js
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { ResetRuntimeUnavailableError } from "./errors.js"
|
|
2
|
+
|
|
3
|
+
function getDefaultWindowTarget() {
|
|
4
|
+
if (typeof window === "undefined") {
|
|
5
|
+
return undefined
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
return window
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export function isResetRuntimeAvailable(target = getDefaultWindowTarget()) {
|
|
12
|
+
return Boolean(
|
|
13
|
+
target &&
|
|
14
|
+
target.reset &&
|
|
15
|
+
typeof target.reset.invoke === "function"
|
|
16
|
+
)
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export function getResetRuntime(target = getDefaultWindowTarget()) {
|
|
20
|
+
if (!isResetRuntimeAvailable(target)) {
|
|
21
|
+
throw new ResetRuntimeUnavailableError()
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
return target.reset
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export async function invokeRaw(command, payload = {}, target = getDefaultWindowTarget()) {
|
|
28
|
+
return getResetRuntime(target).invoke(command, payload)
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export async function invoke(command, payload = {}, target = getDefaultWindowTarget()) {
|
|
32
|
+
const response = await invokeRaw(command, payload, target)
|
|
33
|
+
|
|
34
|
+
if (!response.ok) {
|
|
35
|
+
throw new Error(response.error)
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
return response.result
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export function createResetClient(target = getDefaultWindowTarget()) {
|
|
42
|
+
return {
|
|
43
|
+
isAvailable() {
|
|
44
|
+
return isResetRuntimeAvailable(target)
|
|
45
|
+
},
|
|
46
|
+
invoke(command, payload = {}) {
|
|
47
|
+
return invoke(command, payload, target)
|
|
48
|
+
},
|
|
49
|
+
invokeRaw(command, payload = {}) {
|
|
50
|
+
return invokeRaw(command, payload, target)
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
package/src/errors.js
ADDED
package/src/index.d.ts
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
export type ResetInvokeSuccess<T = unknown> = {
|
|
2
|
+
ok: true;
|
|
3
|
+
result: T;
|
|
4
|
+
};
|
|
5
|
+
|
|
6
|
+
export type ResetInvokeError = {
|
|
7
|
+
ok: false;
|
|
8
|
+
error: string;
|
|
9
|
+
};
|
|
10
|
+
|
|
11
|
+
export type ResetInvokeResponse<T = unknown> =
|
|
12
|
+
| ResetInvokeSuccess<T>
|
|
13
|
+
| ResetInvokeError;
|
|
14
|
+
|
|
15
|
+
export interface ResetRuntime {
|
|
16
|
+
invoke<T = unknown>(
|
|
17
|
+
command: string,
|
|
18
|
+
payload?: unknown
|
|
19
|
+
): Promise<ResetInvokeResponse<T>>;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface ResetRuntimeWindow {
|
|
23
|
+
reset?: ResetRuntime;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
declare global {
|
|
27
|
+
interface Window extends ResetRuntimeWindow {}
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
export class ResetRuntimeUnavailableError extends Error {
|
|
31
|
+
constructor(message?: string);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export function isResetRuntimeAvailable(
|
|
35
|
+
target?: ResetRuntimeWindow
|
|
36
|
+
): boolean;
|
|
37
|
+
|
|
38
|
+
export function getResetRuntime(
|
|
39
|
+
target?: ResetRuntimeWindow
|
|
40
|
+
): ResetRuntime;
|
|
41
|
+
|
|
42
|
+
export function invokeRaw<T = unknown>(
|
|
43
|
+
command: string,
|
|
44
|
+
payload?: unknown,
|
|
45
|
+
target?: ResetRuntimeWindow
|
|
46
|
+
): Promise<ResetInvokeResponse<T>>;
|
|
47
|
+
|
|
48
|
+
export function invoke<T = unknown>(
|
|
49
|
+
command: string,
|
|
50
|
+
payload?: unknown,
|
|
51
|
+
target?: ResetRuntimeWindow
|
|
52
|
+
): Promise<T>;
|
|
53
|
+
|
|
54
|
+
export function createResetClient(target?: ResetRuntimeWindow): {
|
|
55
|
+
isAvailable(): boolean;
|
|
56
|
+
invoke<T = unknown>(command: string, payload?: unknown): Promise<T>;
|
|
57
|
+
invokeRaw<T = unknown>(
|
|
58
|
+
command: string,
|
|
59
|
+
payload?: unknown
|
|
60
|
+
): Promise<ResetInvokeResponse<T>>;
|
|
61
|
+
};
|