lucid-extension-sdk 0.0.71 → 0.0.73

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.71",
+    "version": "0.0.73",
     "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;
@@ -887,7 +892,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/core/checks.d.ts

@@ -53,6 +53,12 @@ export declare function isNumber(val: unknown): val is number;
  * @return Whether variable is an integer.
  */
 export declare function isInt(val: unknown): val is number;
+/**
+ * Returns true if the specified value is either positive or negative infinity.
+ * @param val Variable to test.
+ * @returns Whether variable is positive or negative infinity.
+ */
+export declare function isInfinite(val: unknown): val is number;
 export declare function isFunction(val: unknown): val is (...unknownArgs: any[]) => unknown;
 /**
  * Returns true if the specified value is an object (i.e. it's safe to do property accesses on it).

package/sdk/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -83,6 +83,15 @@ function isInt(val) {
     return isNumber(val) && isFinite(val) && val % 1 == 0;
 }
 exports.isInt = isInt;
+/**
+ * Returns true if the specified value is either positive or negative infinity.
+ * @param val Variable to test.
+ * @returns Whether variable is positive or negative infinity.
+ */
+function isInfinite(val) {
+    return isNumber(val) && !isNaN(val) && !isFinite(val);
+}
+exports.isInfinite = isInfinite;
 function isFunction(val) {
     return typeof val === 'function';
 }

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.