@syncmatters/connector-sdk 1.0.15 → 1.0.16
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/lib/connector.d.ts +5 -7
- package/package.json +3 -3
package/lib/connector.d.ts
CHANGED
|
@@ -91,14 +91,12 @@ export interface Connector {
|
|
|
91
91
|
}
|
|
92
92
|
/** verifyType may be used to check whether the connector class correctly impliments Connector */
|
|
93
93
|
export declare function verifyType(_connector: Connector): void;
|
|
94
|
-
/**
|
|
94
|
+
/**
|
|
95
|
+
* DiscoverOptions are passed to the discover function.
|
|
96
|
+
*/
|
|
95
97
|
export interface DiscoverOptions {
|
|
96
98
|
/** log can record to the platform event store */
|
|
97
99
|
log: Logger;
|
|
98
|
-
/** first setup ("newConnection"), or a re-collect of an existing result ("refresh") */
|
|
99
|
-
reason: "newConnection" | "refresh";
|
|
100
|
-
/** the previous discovery result from this connection, if any */
|
|
101
|
-
previous?: DiscoverResult;
|
|
102
100
|
}
|
|
103
101
|
/** MetaOptions are passed to the meta function. */
|
|
104
102
|
export interface MetaOptions {
|
|
@@ -112,8 +110,8 @@ export interface MetaOptions {
|
|
|
112
110
|
objectMeta(id: string): Promise<ObjectMeta | undefined>;
|
|
113
111
|
/** cached event types - returns undefined when nothing cached */
|
|
114
112
|
events(): Promise<ConnectorMeta["events"] | undefined>;
|
|
115
|
-
/** the cached discovery result - undefined discover() not
|
|
116
|
-
discovery
|
|
113
|
+
/** the cached discovery result - returns undefined when discover() is not implemented or nothing is cached */
|
|
114
|
+
discovery(): Promise<DiscoverResult | undefined>;
|
|
117
115
|
}
|
|
118
116
|
/** QueryOptions are passed to the query function. */
|
|
119
117
|
export interface QueryOptions {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@syncmatters/connector-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.16",
|
|
4
4
|
"description": "TypeScript type definitions for the SyncMatters connector SDK (types only - connectors execute on the SyncMatters platform)",
|
|
5
5
|
"types": "./index.d.ts",
|
|
6
6
|
"exports": {
|
|
@@ -12,9 +12,9 @@
|
|
|
12
12
|
"license": "MIT",
|
|
13
13
|
"author": "SyncMatters",
|
|
14
14
|
"homepage": "https://syncmatters.com",
|
|
15
|
-
"typesContentHash": "
|
|
15
|
+
"typesContentHash": "07fac99bb193fe5a9bff764336c8de1815d3729720589c2d893dd45a987e6eab",
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@types/node": "*",
|
|
18
|
-
"@syncmatters/script-api": "^1.0.
|
|
18
|
+
"@syncmatters/script-api": "^1.0.17"
|
|
19
19
|
}
|
|
20
20
|
}
|