@syncmatters/connector-sdk 1.0.10 → 1.0.11

package/lib/connector.d.ts

@@ -24,7 +24,7 @@ export interface InitArgs {
     readonly webhookUid?: string;
     /** settings holds the configured connection instance settings */
     readonly settings: Map<string, any>;
-    /** if the connection has a managet OAuth2 token this provider will grant access to the access token */
+    /** if the connection has a managed OAuth2 token this provider will grant access to the access token */
     oauth2Provider?: OAuth2TokenProvider;
 }
 /**
@@ -453,16 +453,20 @@ export interface ObjectMetaDetail {
 }
 /**
  * OAuth2TokenProvider provides access to the auto-refreshing OAuth2 access token. Register a callback to the onRefresh
- * event to e.g. auto update HTTP authentication headers.
+ * event to auto update HTTP authentication headers.
  */
 export interface OAuth2TokenProvider {
+    /** current access token cached by the platform */
     token: string;
+    /** authentication parameters included in the token */
     authParams: {
         [key: string]: string | string[];
     };
-    /** called when the background process refreshes the token */
+    /** called when the platform background process has refreshed the token */
     onRefresh: (cb: (token: string) => void) => void;
-    /** force an immediate refresh of the access token (only needed if token expiry is any) */
+    /** replace the in-memory token with the latest platform-cached access token (does not exchange the refresh token, calls onRefresh before returning; rejects if the token could not be retrieved) */
+    reloadToken: () => Promise<void>;
+    /** force an immediate synchronous exchange of the platform refresh token for a new access token (only needed if token expiry is unknown; rejects if the token could not be retrieved) */
     forceRefresh: () => Promise<void>;
     /** introspect the current access token */
     introspectToken?: () => Promise<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncmatters/connector-sdk",
-  "version": "1.0.10",
+  "version": "1.0.11",
   "description": "TypeScript type definitions for the SyncMatters connector SDK (types only - connectors execute on the SyncMatters platform)",
   "types": "./index.d.ts",
   "exports": {
@@ -12,9 +12,9 @@
   "license": "MIT",
   "author": "SyncMatters",
   "homepage": "https://syncmatters.com",
-  "typesContentHash": "bdf8ea0fa31c6e621dbb7a18fc5d88a0d2e708f9ebbc185ad8b5dda2a831c92b",
+  "typesContentHash": "7acede6f1dec917ea321ed2af103576725fe0d3c6844d242ec7d98d226988809",
   "dependencies": {
     "@types/node": "*",
-    "@syncmatters/script-api": "^1.0.10"
+    "@syncmatters/script-api": "^1.0.12"
   }
 }