lucid-extension-sdk 0.0.126 → 0.0.127

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.126",
+    "version": "0.0.127",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "sdk/index.js",
     "types": "sdk/index.d.ts",

package/sdk/commandtypes.d.ts

@@ -92,6 +92,7 @@ export declare const enum CommandName {
     RegisterUnfurl = "ru",
     ReloadExtension = "r",
     SendOAuthRequest = "oauth",
+    SendAsyncOAuthRequest = "aoauth",
     SendPermanentTokenRequest = "perm",
     SendUIMessage = "suim",
     SendXHR = "xhr",
@@ -410,6 +411,10 @@ export declare type CommandArgs = {
         query: SendOAuthRequestQuery;
         result: SendOAuthRequestResponse;
     };
+    [CommandName.SendAsyncOAuthRequest]: {
+        query: SendAsyncOAuthRequestQuery;
+        result: SendOAuthRequestResponse;
+    };
     [CommandName.SendPermanentTokenRequest]: {
         query: SendPermanentTokenRequestQuery;
         result: SendOAuthRequestResponse;
@@ -1025,6 +1030,10 @@ export declare type SendOAuthRequestQuery = SendXHRQuery & {
     /** Post Result To */
     'prt'?: string | undefined;
 };
+export declare type SendAsyncOAuthRequestQuery = SendXHRQuery & {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
 export declare type SendPermanentTokenRequestQuery = SendXHRQuery & {
     /** Permanent token provider name as specified in the package manifest */
     'p': string;

package/sdk/commandtypes.js

@@ -74,6 +74,7 @@ exports.commandTitles = new Map([
     ["ru" /* CommandName.RegisterUnfurl */, 'RegisterUnfurl'],
     ["r" /* CommandName.ReloadExtension */, 'ReloadExtension'],
     ["oauth" /* CommandName.SendOAuthRequest */, 'SendOAuthRequest'],
+    ["aoauth" /* CommandName.SendAsyncOAuthRequest */, 'SendAsyncOAuthRequest'],
     ["suim" /* CommandName.SendUIMessage */, 'SendUIMessage'],
     ["xhr" /* CommandName.SendXHR */, 'SendXHR'],
     ["scp" /* CommandName.SetCurrentPage */, 'SetCurrentPage'],

package/sdk/editorclient.d.ts

@@ -107,6 +107,28 @@ export declare class EditorClient {
         responseFormat: 'binary';
     }): Promise<BinaryXHRResponse>;
     xhr(request: XHRRequest): Promise<XHRResponse>;
+    /**
+     * Make an asyncronous OAuth network request. The request is enqueued to eventually execute. The request may be attempted multiple times with
+     * an overall timeout of 120 seconds.
+     * @param providerName Name of the OAuth provider
+     * @param request Settings for the request
+     * @returns A promise that will either resolve or reject with an XHRResponse. If the HTTP status
+     *   code is not 2xx, the promise will reject.
+     */
+    asyncOAuthXhr(providerName: string, request: OAuthXHRRequest & {
+        responseFormat: 'utf8';
+    }): Promise<TextXHRResponse>;
+    asyncOAuthXhr(providerName: string, request: OAuthXHRRequest & {
+        responseFormat: 'binary';
+    }): Promise<BinaryXHRResponse>;
+    asyncOAuthXhr(providerName: string, request: OAuthXHRRequest): Promise<XHRResponse>;
+    /**
+     * Make an OAuth network request. Make the request immediately and only once with a 10 second timeout.
+     * @param providerName Name of the OAuth provider
+     * @param request Settings for the request
+     * @returns A promise that will either resolve or reject with an XHRResponse. If the HTTP status
+     *   code is not 2xx, the promise will reject.
+     */
     oauthXhr(providerName: string, request: OAuthXHRRequest & {
         responseFormat: 'utf8';
     }): Promise<TextXHRResponse>;

package/sdk/editorclient.js

@@ -183,6 +183,17 @@ class EditorClient {
             throw parseRawXHRResponse(responseFormat, raw);
         });
     }
+    asyncOAuthXhr(providerName, request) {
+        const responseFormat = request.responseFormat || 'utf8';
+        return this.sendCommand("aoauth" /* CommandName.SendAsyncOAuthRequest */, Object.assign({ 'url': request.url, 'm': request.method, 'd': request.data, 'h': request.headers, 'ms': request.timeoutMs, 'p': providerName, 'f': responseFormat }, (request.postResultTo ? { 'prt': request.postResultTo } : {})))
+            .then((raw) => {
+            return parseRawXHRResponse(responseFormat, raw);
+        })
+            .catch((error) => {
+            const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
+            throw parseRawXHRResponse(responseFormat, raw);
+        });
+    }
     oauthXhr(providerName, request) {
         const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("oauth" /* CommandName.SendOAuthRequest */, Object.assign({ 'url': request.url, 'm': request.method, 'd': request.data, 'h': request.headers, 'ms': request.timeoutMs, 'p': providerName, 'f': responseFormat }, (request.postResultTo ? { 'prt': request.postResultTo } : {})))