lucid-extension-sdk 0.0.72 → 0.0.74

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -81,6 +81,7 @@ export declare const enum CommandName {
     RegisterUnfurl = "ru",
     ReloadExtension = "r",
     SendOAuthRequest = "oauth",
+    SendPermanentTokenRequest = "perm",
     SendUIMessage = "suim",
     SendXHR = "xhr",
     SetCurrentPage = "scp",
@@ -358,6 +359,10 @@ export declare type CommandArgs = {
         query: SendOAuthRequestQuery;
         result: SendOAuthRequestResponse;
     };
+    [CommandName.SendPermanentTokenRequest]: {
+        query: SendPermanentTokenRequestQuery;
+        result: SendOAuthRequestResponse;
+    };
     [CommandName.SendUIMessage]: {
         query: SendUIMessageQuery;
         result: SendUIMessageResult;
@@ -872,6 +877,8 @@ export declare type RegisterPanelQuery = {
     'c': string;
     /** Icon URL, preferably a base64-encoded URL */
     'i': string;
+    /** tooltip */
+    'to'?: string;
 };
 export declare type RegisterPanelResult = undefined;
 export declare type RegisterUnfurlQuery = {
@@ -887,7 +894,12 @@ export declare type SendOAuthRequestQuery = 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;
+};
 export declare type SendOAuthRequestResponse = SendXHRResponse;
+export declare type SendPermanentTokenRequestResponse = SendXHRResponse;
 export declare type SendUIMessageQuery = {
     /** Name of the UI component's action for receiving events, e.g. ShowModalQuery['n'] */
     'n': string;

package/sdk/editorclient.d.ts

@@ -82,6 +82,20 @@ export declare class EditorClient {
         responseFormat: 'binary';
     }): Promise<BinaryXHRResponse>;
     oauthXhr(providerName: string, request: XHRRequest): Promise<XHRResponse>;
+    /**
+     * Make a request with a permanent token like a merge account token or API key.
+     * @param providerName The name of the authorization provider from the manifest
+     * @param request Settings for the network 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.
+     * @ignore */
+    permanentTokenXhr(providerName: string, request: XHRRequest & {
+        responseFormat: 'utf8';
+    }): Promise<TextXHRResponse>;
+    permanentTokenXhr(providerName: string, request: XHRRequest & {
+        responseFormat: 'binary';
+    }): Promise<BinaryXHRResponse>;
+    permanentTokenXhr(providerName: string, request: XHRRequest): Promise<XHRResponse>;
     /**
      * Register a named action. These actions can be triggered from custom UI, for example as the action of a
      * custom menu item.

package/sdk/editorclient.js

@@ -159,6 +159,25 @@ class EditorClient {
             throw parseRawXHRResponse(responseFormat, raw);
         });
     }
+    permanentTokenXhr(providerName, request) {
+        const responseFormat = request.responseFormat || 'utf8';
+        return this.sendCommand("perm" /* CommandName.SendPermanentTokenRequest */, {
+            'url': request.url,
+            'm': request.method,
+            'd': request.data,
+            'h': request.headers,
+            'ms': request.timeoutMs,
+            'p': providerName,
+            'f': responseFormat,
+        })
+            .then((raw) => {
+            return parseRawXHRResponse(responseFormat, raw);
+        })
+            .catch((error) => {
+            const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
+            throw parseRawXHRResponse(responseFormat, raw);
+        });
+    }
     /**
      * Register a named action. These actions can be triggered from custom UI, for example as the action of a
      * custom menu item.