lucid-extension-sdk 0.0.45 → 0.0.46

package/package.json

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

package/sdk/core/checks.d.ts

@@ -99,3 +99,14 @@ export declare function isEmptyOrNullishObject(val: unknown): val is {};
 export declare function isAny(val: unknown): val is any;
 export declare function isUnknown(val: unknown): val is unknown;
 export declare function isPromise(val: unknown): val is Promise<unknown>;
+export declare function isLiteral<T extends string | number | symbol>(t: T): (x: unknown) => x is T;
+declare type AbstractConstructor<T> = Function & {
+    prototype: T;
+};
+/**
+ * Since `instanceof` should generally be avoided, this function should generally be avoided as well.
+ *
+ * A valid use case is for native types, like Uint8Array.
+ */
+export declare function isInstanceOf<T>(klass: AbstractConstructor<T>): (x: unknown) => x is T;
+export {};

package/sdk/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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.
  *
@@ -163,3 +163,16 @@ function isPromise(val) {
     return isObject(val) && isFunction(val['then']) && isFunction(val['catch']);
 }
 exports.isPromise = isPromise;
+function isLiteral(t) {
+    return (x) => x === t;
+}
+exports.isLiteral = isLiteral;
+/**
+ * Since `instanceof` should generally be avoided, this function should generally be avoided as well.
+ *
+ * A valid use case is for native types, like Uint8Array.
+ */
+function isInstanceOf(klass) {
+    return (x) => x instanceof klass;
+}
+exports.isInstanceOf = isInstanceOf;

package/sdk/core/xhr.d.ts

@@ -0,0 +1,49 @@
+import { SendXHRResponseFormat } from '../commandtypes';
+import { Validator } from './guards';
+export interface XHRRequest {
+    /** URL to request */
+    url: string;
+    /** HTTP method, e.g. "POST". If omitted, GET is used */
+    method?: string;
+    /** The data to send as the body of the request  */
+    data?: string;
+    /** Headers to send with the request. If specifying an array, multiple headers with the same name will be sent */
+    headers?: {
+        [key: string]: string | string[];
+    };
+    /** If specified, this request should time out after the given number of milliseconds */
+    timeoutMs?: number;
+    /**
+     * The desired format for the returned response body. Defaults to 'utf8'.
+     *
+     * - If 'utf8', the response body will be returned as a string.
+     * - If 'binary', the response body will be returned as a Uint8Array.
+     */
+    responseFormat?: SendXHRResponseFormat;
+}
+export interface BaseXHRResponse {
+    /** URL of the final response, after any redirects */
+    url: string;
+    /** HTTP status, e.g. 200 or 404 */
+    status: number;
+    /** Headers sent by the server in the response */
+    headers: {
+        [key: string]: string;
+    };
+    /** True if this request failed due to a timeout */
+    timeout?: boolean;
+}
+export interface TextXHRResponse extends BaseXHRResponse {
+    responseFormat: 'utf8';
+    /** Plain text of the response body */
+    responseText: string;
+}
+export interface BinaryXHRResponse extends BaseXHRResponse {
+    responseFormat: 'binary';
+    /** Contents of the response body */
+    responseData: Uint8Array;
+}
+export declare type XHRResponse = TextXHRResponse | BinaryXHRResponse;
+export declare const isTextXHRResponse: Validator<TextXHRResponse>;
+export declare const isBinaryXHRResponse: Validator<BinaryXHRResponse>;
+export declare const isXHRResponse: Validator<XHRResponse>;

package/sdk/core/xhr.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isXHRResponse = exports.isBinaryXHRResponse = exports.isTextXHRResponse = void 0;
+const checks_1 = require("./checks");
+const validators_1 = require("./validators/validators");
+const isBaseXHRResponse = (0, validators_1.objectValidator)({
+    url: checks_1.isString,
+    status: checks_1.isNumber,
+    headers: (0, validators_1.objectOfValidator)(checks_1.isString),
+    timeout: (0, validators_1.option)(checks_1.isBoolean),
+});
+exports.isTextXHRResponse = (0, validators_1.both)(isBaseXHRResponse, (0, validators_1.objectValidator)({
+    responseFormat: (0, checks_1.isLiteral)('utf8'),
+    responseText: checks_1.isString,
+}));
+exports.isBinaryXHRResponse = (0, validators_1.both)(isBaseXHRResponse, (0, validators_1.objectValidator)({
+    responseFormat: (0, checks_1.isLiteral)('binary'),
+    responseData: (0, checks_1.isInstanceOf)(Uint8Array),
+}));
+exports.isXHRResponse = (0, validators_1.either)(exports.isTextXHRResponse, exports.isBinaryXHRResponse);

package/sdk/editorclient.d.ts

@@ -1,6 +1,7 @@
-import { CommandArgs, CommandName, SendXHRResponseFormat, UnionToIntersection } from './commandtypes';
+import { CommandArgs, CommandName, UnionToIntersection } from './commandtypes';
 import { JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
+import { BinaryXHRResponse, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
 import { CollectionProxy } from './data/collectionproxy';
 import { BlockDefinition } from './document/blockdefinition';
 import { BlockProxy } from './document/blockproxy';
@@ -9,50 +10,6 @@ import { GroupProxy } from './document/groupproxy';
 import { LineProxy } from './document/lineproxy';
 import { PageProxy } from './document/pageproxy';
 import { FileUploadData } from './ui/menu';
-export interface XHRRequest {
-    /** URL to request */
-    url: string;
-    /** HTTP method, e.g. "POST". If omitted, GET is used */
-    method?: string;
-    /** The data to send as the body of the request  */
-    data?: string;
-    /** Headers to send with the request. If specifying an array, multiple headers with the same name will be sent */
-    headers?: {
-        [key: string]: string | string[];
-    };
-    /** If specified, this request should time out after the given number of milliseconds */
-    timeoutMs?: number;
-    /**
-     * The desired format for the returned response body. Defaults to 'utf8'.
-     *
-     * - If 'utf8', the response body will be returned as a string.
-     * - If 'binary', the response body will be returned as a Uint8Array.
-     */
-    responseFormat?: SendXHRResponseFormat;
-}
-export interface BaseXHRResponse {
-    /** URL of the final response, after any redirects */
-    url: string;
-    /** HTTP status, e.g. 200 or 404 */
-    status: number;
-    /** Headers sent by the server in the response */
-    headers: {
-        [key: string]: string;
-    };
-    /** True if this request failed due to a timeout */
-    timeout?: boolean;
-}
-export interface TextXHRResponse extends BaseXHRResponse {
-    responseFormat: 'utf8';
-    /** Plain text of the response body */
-    responseText: string;
-}
-export interface BinaryXHRResponse extends BaseXHRResponse {
-    responseFormat: 'binary';
-    /** Contents of the response body */
-    responseData: Uint8Array;
-}
-export declare type XHRResponse = TextXHRResponse | BinaryXHRResponse;
 export declare type DataActionResult = {
     /** The HTTP Status Code from the Extension Data Sync endpoint */
     'status': number;

package/sdk/editorclient.js

@@ -16,7 +16,7 @@ const elementproxy_1 = require("./document/elementproxy");
 const groupproxy_1 = require("./document/groupproxy");
 const lineproxy_1 = require("./document/lineproxy");
 const pageproxy_1 = require("./document/pageproxy");
-const registerunfurlmessage_1 = require("./message/registerunfurlmessage");
+const unfurleventmessage_1 = require("./message/unfurleventmessage");
 function parseRawXHRResponse(responseFormat, raw) {
     var _a, _b, _c, _d;
     return Object.assign({ url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '', status: (_b = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _b !== void 0 ? _b : 0, headers: (_c = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _c !== void 0 ? _c : {}, timeout: raw === null || raw === void 0 ? void 0 : raw['to'] }, (responseFormat === 'utf8'
@@ -207,12 +207,17 @@ class EditorClient {
         const action = this.getUniqueActionName();
         this.registerAction(action, async (rawMsg) => {
             var _a;
-            const msg = (0, registerunfurlmessage_1.deserializeRegisterUnfurlMessage)(rawMsg);
+            const msg = (0, unfurleventmessage_1.deserializeUnfurlEventMessage)(rawMsg);
             switch (msg.unfurlCallbackType) {
                 case unfurlcallbacks_1.UnfurlCallbackType.Unfurl: {
-                    const result = await callbacks.unfurlCallback(msg.url);
-                    if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
-                        return (0, unfurldetails_1.serializeUnfurlDetails)(result);
+                    try {
+                        const result = await callbacks.unfurlCallback(msg.url);
+                        if (result && !(0, unfurlrefresherrortype_1.unfurlRefreshErrorTypeValidator)(result)) {
+                            return (0, unfurldetails_1.serializeUnfurlDetails)(result);
+                        }
+                    }
+                    catch (err) {
+                        return unfurlrefresherrortype_1.UnfurlRefreshErrorType.GenericFailure;
                     }
                     break;
                 }

package/sdk/index.d.ts

@@ -5,6 +5,7 @@ export * from './core/offsettype';
 export * from './core/serializeddataerror';
 export * from './core/shapedatainheritance';
 export * from './core/unfurl/unfurldetails';
+export * from './core/xhr';
 export * from './data/collectionproxy';
 export * from './data/dataerror';
 export * from './data/dataitemproxy';

package/sdk/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./core/offsettype"), exports);
 __exportStar(require("./core/serializeddataerror"), exports);
 __exportStar(require("./core/shapedatainheritance"), exports);
 __exportStar(require("./core/unfurl/unfurldetails"), exports);
+__exportStar(require("./core/xhr"), exports);
 __exportStar(require("./data/collectionproxy"), exports);
 __exportStar(require("./data/dataerror"), exports);
 __exportStar(require("./data/dataitemproxy"), exports);

package/sdk/message/unfurleventmessage.d.ts

@@ -0,0 +1,24 @@
+import { JsonObject } from '../core/jsonserializable';
+import { UnfurlCallbackType } from '../core/unfurl/unfurlcallbacks';
+/** @ignore */
+export interface UnfurlEventMessage {
+    /** @ignore */
+    id: string;
+    /** @ignore */
+    url: string;
+    /** @ignore */
+    unfurlCallbackType: UnfurlCallbackType;
+    /** @ignore */
+    blockId?: string;
+}
+/** @ignore */
+export interface SerializedUnfurlEventMessage extends JsonObject {
+    'id': string;
+    'u': string;
+    't': UnfurlCallbackType;
+    'b'?: string;
+}
+/** @ignore */
+export declare function deserializeUnfurlEventMessage(raw: SerializedUnfurlEventMessage): UnfurlEventMessage;
+/** @ignore */
+export declare function serializeUnfurlEventMessage(concrete: UnfurlEventMessage): SerializedUnfurlEventMessage;

package/sdk/message/unfurleventmessage.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeUnfurlEventMessage = exports.deserializeUnfurlEventMessage = void 0;
+/** @ignore */
+function deserializeUnfurlEventMessage(raw) {
+    return {
+        id: raw['id'],
+        url: raw['u'],
+        unfurlCallbackType: raw['t'],
+        blockId: raw['b'],
+    };
+}
+exports.deserializeUnfurlEventMessage = deserializeUnfurlEventMessage;
+/** @ignore */
+function serializeUnfurlEventMessage(concrete) {
+    return {
+        'id': concrete.id,
+        'u': concrete.url,
+        't': concrete.unfurlCallbackType,
+        'b': concrete.blockId,
+    };
+}
+exports.serializeUnfurlEventMessage = serializeUnfurlEventMessage;

package/sdk/message/registerunfurlmessage.d.ts

@@ -1,32 +0,0 @@
-import { JsonObject } from '../../lucid-extension-sdk';
-import { isString } from '../core/checks';
-import { UnfurlCallbackType } from '../core/unfurl/unfurlcallbacks';
-/** @ignore */
-export interface RegisterUnfurlMessage {
-    /** @ignore */
-    id: string;
-    /** @ignore */
-    url: string;
-    /** @ignore */
-    unfurlCallbackType: UnfurlCallbackType;
-    /** @ignore */
-    blockId?: string;
-}
-/** @ignore */
-export interface SerializedRegisterUnfurlMessage extends JsonObject {
-    'id': string;
-    'u': string;
-    't': UnfurlCallbackType;
-    'b'?: string;
-}
-/** @ignore */
-export declare const isValidRegisterUnfurlMessage: (subject: unknown) => subject is import("../core/guards").DestructureGuardedTypeObj<{
-    id: typeof isString;
-    u: typeof isString;
-    t: (x: unknown) => x is UnfurlCallbackType;
-    b: (x: unknown) => x is string | undefined;
-}>;
-/** @ignore */
-export declare function deserializeRegisterUnfurlMessage(raw: SerializedRegisterUnfurlMessage): RegisterUnfurlMessage;
-/** @ignore */
-export declare function serializeRegisterUnfurlMessage(concrete: RegisterUnfurlMessage): SerializedRegisterUnfurlMessage;

package/sdk/message/registerunfurlmessage.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeRegisterUnfurlMessage = exports.deserializeRegisterUnfurlMessage = exports.isValidRegisterUnfurlMessage = void 0;
-const checks_1 = require("../core/checks");
-const unfurlcallbacks_1 = require("../core/unfurl/unfurlcallbacks");
-const validators_1 = require("../core/validators/validators");
-/** @ignore */
-exports.isValidRegisterUnfurlMessage = (0, validators_1.objectValidator)({
-    'id': checks_1.isString,
-    'u': checks_1.isString,
-    't': (0, validators_1.stringEnumValidator)(unfurlcallbacks_1.UnfurlCallbackType),
-    'b': (0, validators_1.option)(checks_1.isString),
-});
-/** @ignore */
-function deserializeRegisterUnfurlMessage(raw) {
-    return {
-        id: raw['id'],
-        url: raw['u'],
-        unfurlCallbackType: raw['t'],
-        blockId: raw['b'],
-    };
-}
-exports.deserializeRegisterUnfurlMessage = deserializeRegisterUnfurlMessage;
-/** @ignore */
-function serializeRegisterUnfurlMessage(concrete) {
-    return {
-        'id': concrete.id,
-        'u': concrete.url,
-        't': concrete.unfurlCallbackType,
-        'b': concrete.blockId,
-    };
-}
-exports.serializeRegisterUnfurlMessage = serializeRegisterUnfurlMessage;