lucid-extension-sdk 0.0.37 → 0.0.39

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -854,6 +854,7 @@ export declare type SendUIMessageQuery = {
     'd'?: JsonSerializable;
 };
 export declare type SendUIMessageResult = undefined;
+export declare type SendXHRResponseFormat = 'utf8' | 'binary';
 export declare type SendXHRQuery = {
     'url': string;
     /** HTTP method, e.g. 'GET', 'FETCH', etc. Defaults to GET */
@@ -873,11 +874,18 @@ export declare type SendXHRQuery = {
     };
     /** Timeout in milliseconds, if specified */
     'ms'?: 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.
+     */
+    'f'?: SendXHRResponseFormat;
 };
 export declare type RawSendXHRResponse = {
     /** URL of the response after any redirects */
     'url': string;
-    /** Plain-text response body */
+    /** Plain-text or base64-encoded response body */
     't': string;
     /** Status code of the response */
     's': number;

package/sdk/core/data/fieldtypedefinition/semantickind.d.ts

@@ -0,0 +1,14 @@
+export declare enum SemanticKind {
+    Id = "id",
+    Title = "title",
+    Name = "name",
+    Image = "image",
+    Description = "description",
+    Assignee = "assignee",
+    Estimate = "estimate",
+    Status = "status",
+    StartTime = "starttime",
+    EndTime = "endtime",
+    GroupByHint = "groupbyhint",
+    PrimaryKeyReference = "primarykeyreference"
+}

package/sdk/core/data/fieldtypedefinition/semantickind.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SemanticKind = void 0;
+var SemanticKind;
+(function (SemanticKind) {
+    SemanticKind["Id"] = "id";
+    SemanticKind["Title"] = "title";
+    SemanticKind["Name"] = "name";
+    SemanticKind["Image"] = "image";
+    SemanticKind["Description"] = "description";
+    SemanticKind["Assignee"] = "assignee";
+    SemanticKind["Estimate"] = "estimate";
+    SemanticKind["Status"] = "status";
+    SemanticKind["StartTime"] = "starttime";
+    SemanticKind["EndTime"] = "endtime";
+    SemanticKind["GroupByHint"] = "groupbyhint";
+    SemanticKind["PrimaryKeyReference"] = "primarykeyreference";
+})(SemanticKind = exports.SemanticKind || (exports.SemanticKind = {}));

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -1,10 +1,12 @@
 import { JsonSerializable } from '../../jsonserializable';
 import { SerializedFieldTypeDefinition } from '../fieldtypedefinition/fieldtypedefinition';
+import { SemanticKind } from '../fieldtypedefinition/semantickind';
 export declare type SerializedFieldDefinition = {
     'Name': string;
     'Type': SerializedFieldTypeDefinition;
     'Constraints'?: SerializedFieldConstraint[];
     'SyncSchema'?: string;
+    'Mapping'?: SemanticKind[];
 };
 export declare enum FieldConstraintType {
     REQUIRED = "required",

package/sdk/editorclient.d.ts

@@ -1,4 +1,4 @@
-import { CommandArgs, CommandName, UnionToIntersection } from './commandtypes';
+import { CommandArgs, CommandName, SendXHRResponseFormat, UnionToIntersection } from './commandtypes';
 import { JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { CollectionProxy } from './data/collectionproxy';
@@ -22,12 +22,17 @@ export interface XHRRequest {
     };
     /** 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 XHRResponse {
+export interface BaseXHRResponse {
     /** URL of the final response, after any redirects */
     url: string;
-    /** Plain text of the response body */
-    responseText: string;
     /** HTTP status, e.g. 200 or 404 */
     status: number;
     /** Headers sent by the server in the response */
@@ -37,6 +42,17 @@ export interface XHRResponse {
     /** 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;
@@ -95,7 +111,19 @@ export declare class EditorClient {
      * @returns A promise that will either resolve or reject with an XHRResponse. If the HTTP status
      *   code is not 2xx, the promise will reject.
      */
+    xhr(request: XHRRequest & {
+        responseFormat: 'utf8';
+    }): Promise<TextXHRResponse>;
+    xhr(request: XHRRequest & {
+        responseFormat: 'binary';
+    }): Promise<BinaryXHRResponse>;
     xhr(request: XHRRequest): Promise<XHRResponse>;
+    oauthXhr(providerName: string, request: XHRRequest & {
+        responseFormat: 'utf8';
+    }): Promise<TextXHRResponse>;
+    oauthXhr(providerName: string, request: XHRRequest & {
+        responseFormat: 'binary';
+    }): Promise<BinaryXHRResponse>;
     oauthXhr(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

package/sdk/editorclient.js

@@ -15,6 +15,18 @@ const groupproxy_1 = require("./document/groupproxy");
 const lineproxy_1 = require("./document/lineproxy");
 const pageproxy_1 = require("./document/pageproxy");
 const registerunfurlmessage_1 = require("./message/registerunfurlmessage");
+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'
+        ? {
+            responseFormat,
+            responseText: (_d = raw === null || raw === void 0 ? void 0 : raw['t']) !== null && _d !== void 0 ? _d : 'An unknown error occurred',
+        }
+        : {
+            responseFormat,
+            responseData: (raw === null || raw === void 0 ? void 0 : raw['t']) ? (0, base64_1.decodeBase64)(raw['t']) : new Uint8Array(0),
+        }));
+}
 class EditorClient {
     constructor() {
         this.nextId = 0;
@@ -108,42 +120,26 @@ class EditorClient {
             't': timeout,
         }), this);
     }
-    /**
-     * Make a network request
-     * @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.
-     */
     xhr(request) {
+        const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("xhr" /* SendXHR */, {
             'url': request.url,
             'm': request.method,
             'd': request.data,
             'h': request.headers,
             'ms': request.timeoutMs,
+            'f': responseFormat,
         })
             .then((raw) => {
-            return {
-                url: raw['url'],
-                responseText: raw['t'],
-                status: raw['s'],
-                headers: raw['h'],
-                timeout: raw['to'],
-            };
+            return parseRawXHRResponse(responseFormat, raw);
         })
             .catch((error) => {
-            var _a, _b, _c, _d;
             const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
-            throw {
-                url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '',
-                responseText: (_b = raw === null || raw === void 0 ? void 0 : raw['t']) !== null && _b !== void 0 ? _b : 'An unknown error occurred',
-                status: (_c = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _c !== void 0 ? _c : 0,
-                headers: (_d = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _d !== void 0 ? _d : {},
-                timeout: raw === null || raw === void 0 ? void 0 : raw['to'],
-            };
+            throw parseRawXHRResponse(responseFormat, raw);
         });
     }
     oauthXhr(providerName, request) {
+        const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("oauth" /* SendOAuthRequest */, {
             'url': request.url,
             'm': request.method,
@@ -151,26 +147,14 @@ class EditorClient {
             'h': request.headers,
             'ms': request.timeoutMs,
             'p': providerName,
+            'f': responseFormat,
         })
             .then((raw) => {
-            return {
-                url: raw['url'],
-                responseText: raw['t'],
-                status: raw['s'],
-                headers: raw['h'],
-                timeout: raw['to'],
-            };
+            return parseRawXHRResponse(responseFormat, raw);
         })
             .catch((error) => {
-            var _a, _b, _c, _d;
             const raw = (0, commandtypes_1.isRawSendXHRResponse)(error) ? error : undefined;
-            throw {
-                url: (_a = raw === null || raw === void 0 ? void 0 : raw['url']) !== null && _a !== void 0 ? _a : '',
-                responseText: (_b = raw === null || raw === void 0 ? void 0 : raw['t']) !== null && _b !== void 0 ? _b : 'An unknown error occurred',
-                status: (_c = raw === null || raw === void 0 ? void 0 : raw['s']) !== null && _c !== void 0 ? _c : 0,
-                headers: (_d = raw === null || raw === void 0 ? void 0 : raw['h']) !== null && _d !== void 0 ? _d : {},
-                timeout: raw === null || raw === void 0 ? void 0 : raw['to'],
-            };
+            throw parseRawXHRResponse(responseFormat, raw);
         });
     }
     /**