@signalk/server-api 2.0.0-beta.1 → 2.0.0-beta.3
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/dist/autopilot.d.ts +28 -0
- package/dist/autopilot.js +2 -0
- package/dist/index.d.ts +30 -6
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +3475 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface AutopilotApi {
|
|
2
|
+
register: (pluginId: string, provider: AutopilotProvider) => void;
|
|
3
|
+
unRegister: (pluginId: string) => void;
|
|
4
|
+
getStates: () => Promise<[string]>;
|
|
5
|
+
setState: (state: string) => Promise<void>;
|
|
6
|
+
getModes: () => Promise<[string]>;
|
|
7
|
+
setMode: (mode: string) => Promise<void>;
|
|
8
|
+
setTarget: (value: number) => Promise<void>;
|
|
9
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
10
|
+
tack: (port: boolean) => Promise<void>;
|
|
11
|
+
}
|
|
12
|
+
export interface AutopilotProvider {
|
|
13
|
+
pilotType: string;
|
|
14
|
+
methods: AutopilotProviderMethods;
|
|
15
|
+
}
|
|
16
|
+
export interface AutopilotProviderMethods {
|
|
17
|
+
pluginId?: string;
|
|
18
|
+
getStates: () => Promise<[string]>;
|
|
19
|
+
setState: (state: string) => Promise<void>;
|
|
20
|
+
getModes: () => Promise<[string]>;
|
|
21
|
+
setMode: (mode: string) => Promise<void>;
|
|
22
|
+
setTarget: (value: number) => Promise<void>;
|
|
23
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
24
|
+
tack: (port: boolean) => Promise<void>;
|
|
25
|
+
}
|
|
26
|
+
export interface AutopilotProviderRegistry {
|
|
27
|
+
registerAutopilotProvider: (provider: AutopilotProvider) => void;
|
|
28
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -16,27 +16,26 @@ export interface ResourcesApi {
|
|
|
16
16
|
unRegister: (pluginId: string) => void;
|
|
17
17
|
listResources: (resType: SignalKResourceType, params: {
|
|
18
18
|
[key: string]: any;
|
|
19
|
-
}) => Promise<{
|
|
19
|
+
}, providerId?: string) => Promise<{
|
|
20
20
|
[id: string]: any;
|
|
21
21
|
}>;
|
|
22
|
-
getResource: (resType: SignalKResourceType, resId: string) => Promise<object>;
|
|
22
|
+
getResource: (resType: SignalKResourceType, resId: string, providerId?: string) => Promise<object>;
|
|
23
23
|
setResource: (resType: SignalKResourceType, resId: string, data: {
|
|
24
24
|
[key: string]: any;
|
|
25
|
-
}) => Promise<void>;
|
|
26
|
-
deleteResource: (resType: SignalKResourceType, resId: string) => Promise<void>;
|
|
25
|
+
}, providerId?: string) => Promise<void>;
|
|
26
|
+
deleteResource: (resType: SignalKResourceType, resId: string, providerId?: string) => Promise<void>;
|
|
27
27
|
}
|
|
28
28
|
export interface ResourceProvider {
|
|
29
29
|
type: ResourceType;
|
|
30
30
|
methods: ResourceProviderMethods;
|
|
31
31
|
}
|
|
32
32
|
export interface ResourceProviderMethods {
|
|
33
|
-
pluginId?: string;
|
|
34
33
|
listResources: (query: {
|
|
35
34
|
[key: string]: any;
|
|
36
35
|
}) => Promise<{
|
|
37
36
|
[id: string]: any;
|
|
38
37
|
}>;
|
|
39
|
-
getResource: (id: string) => Promise<object>;
|
|
38
|
+
getResource: (id: string, property?: string) => Promise<object>;
|
|
40
39
|
setResource: (id: string, value: {
|
|
41
40
|
[key: string]: any;
|
|
42
41
|
}) => Promise<void>;
|
|
@@ -45,6 +44,31 @@ export interface ResourceProviderMethods {
|
|
|
45
44
|
export interface ResourceProviderRegistry {
|
|
46
45
|
registerResourceProvider: (provider: ResourceProvider) => void;
|
|
47
46
|
}
|
|
47
|
+
export interface AutopilotApi {
|
|
48
|
+
register: (pluginId: string, provider: AutopilotProvider) => void;
|
|
49
|
+
unRegister: (pluginId: string) => void;
|
|
50
|
+
}
|
|
51
|
+
export interface AutopilotProvider {
|
|
52
|
+
pilotType: string;
|
|
53
|
+
methods: AutopilotProviderMethods;
|
|
54
|
+
}
|
|
55
|
+
export interface AutopilotProviderMethods {
|
|
56
|
+
pluginId?: string;
|
|
57
|
+
engage: (enable: boolean) => Promise<void>;
|
|
58
|
+
getConfig: () => Promise<{
|
|
59
|
+
[key: string]: any;
|
|
60
|
+
}>;
|
|
61
|
+
getState: () => Promise<string>;
|
|
62
|
+
setState: (state: string) => Promise<void>;
|
|
63
|
+
getMode: () => Promise<string>;
|
|
64
|
+
setMode: (mode: string) => Promise<void>;
|
|
65
|
+
setTarget: (value: number) => Promise<void>;
|
|
66
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
67
|
+
tack: (port: boolean) => Promise<void>;
|
|
68
|
+
}
|
|
69
|
+
export interface AutopilotProviderRegistry {
|
|
70
|
+
registerAutopilotProvider: (provider: AutopilotProvider) => void;
|
|
71
|
+
}
|
|
48
72
|
declare type Unsubscribe = () => {};
|
|
49
73
|
export interface PropertyValuesEmitter {
|
|
50
74
|
emitPropertyValue: (name: string, value: any) => void;
|
package/package.json
CHANGED