lucid-extension-sdk 0.0.112 → 0.0.114

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -103,6 +103,7 @@ export declare const enum CommandName {
     StartDragBlockToCanvas = "sdc",
     StartPDFUploadRequest = "pdf",
     ThrowForTestCase = "throw",
+    TriggerAuthFlow = "tauth",
     UnhookCreateItems = "uci",
     UnhookDeleteItems = "udi",
     UnhookSelection = "us",
@@ -452,6 +453,10 @@ export declare type CommandArgs = {
         query: ThrowForTestCaseQuery;
         result: ThrowForTestCaseResult;
     };
+    [CommandName.TriggerAuthFlow]: {
+        query: TriggerAuthFlowQuery;
+        result: TriggerAuthFlowResult;
+    };
     [CommandName.UnhookCreateItems]: {
         query: UnhookCreateItemsQuery;
         result: UnhookCreateItemsResult;
@@ -1108,6 +1113,14 @@ export declare type StartPDFUploadRequestQuery = string;
 export declare type StartPDFUploadRequestResponse = Promise<string>;
 export declare type ThrowForTestCaseQuery = number;
 export declare type ThrowForTestCaseResult = undefined | Promise<void>;
+export declare type TriggerAuthFlowQuery = {
+    /** OAuth or merge provider name as specified in the package manifest */
+    'p': string;
+};
+export declare type TriggerAuthFlowResult = Promise<RawTriggerAuthFlowResult>;
+export declare type RawTriggerAuthFlowResult = {
+    's': boolean;
+};
 export declare type UnhookCreateItemsQuery = {
     /** Name of the action passed to HookCreateItems */
     'n': string;

package/sdk/commandtypes.js

@@ -84,6 +84,7 @@ exports.commandTitles = new Map([
     ["sdc" /* CommandName.StartDragBlockToCanvas */, 'StartDragBlockToCanvas'],
     ["pdf" /* CommandName.StartPDFUploadRequest */, 'StartPDFUploadRequest'],
     ["throw" /* CommandName.ThrowForTestCase */, 'ThrowForTestCase'],
+    ["tauth" /* CommandName.TriggerAuthFlow */, 'TriggerAuthFlow'],
     ["uci" /* CommandName.UnhookCreateItems */, 'UnhookCreateItems'],
     ["udi" /* CommandName.UnhookDeleteItems */, 'UnhookDeleteItems'],
     ["us" /* CommandName.UnhookSelection */, 'UnhookSelection'],

package/sdk/dataconnector/dataconnector.d.ts

@@ -18,12 +18,18 @@ export declare type DataConnectorRoute = (args: {
 }>;
 /** Throw this from an action request handler to produce a non-200 response code and not have to return the expected
  * result type */
-export declare class DataConnectorRunError {
+export declare class DataConnectorRunError extends Error {
     status: number;
     body: unknown;
-    constructor(status: number, body: unknown);
+    constructor(status: number, body: unknown, message?: string);
     static withMessage(status: number, message: string): DataConnectorRunError;
 }
+/** Thrown by any failable http APIs */
+export declare class DataConnectorRequestError extends Error {
+    status: number;
+    response: string;
+    constructor(status: number, message: string, response: string);
+}
 declare type ActionTypeForName<Name extends string, Asynchronous = boolean> = Name extends `${DataConnectorActionKeys.Patch}` ? ActionRequest<DataConnectorPatchAction, PatchChange[]> : Name extends `${DataConnectorActionKeys.UnbatchedPatch}` ? ActionRequest<DataConnectorPatchAction, PatchChange[]> : Name extends `${DataConnectorActionKeys.ManageWebhook}` ? ActionRequest<DataConnectorManageWebhookAction, Webhook> : ActionRequest<Asynchronous extends true ? DataConnectorAsynchronousAction : DataConnectorAction>;
 /** Factory class to define a bunch of action handlers. */
 export declare class DataConnector {

package/sdk/dataconnector/dataconnector.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataConnector = exports.DataConnectorRunError = void 0;
+exports.DataConnector = exports.DataConnectorRequestError = exports.DataConnectorRunError = void 0;
 const action_1 = require("./actions/action");
 const dataconnectoractionkeys_1 = require("./actions/dataconnectoractionkeys");
 const managewebhookresponsebody_1 = require("./actions/managewebhookresponsebody");
@@ -8,16 +8,26 @@ const patchresponsebody_1 = require("./actions/patchresponsebody");
 const debugserver_1 = require("./debugserver");
 /** Throw this from an action request handler to produce a non-200 response code and not have to return the expected
  * result type */
-class DataConnectorRunError {
-    constructor(status, body) {
+class DataConnectorRunError extends Error {
+    constructor(status, body, message) {
+        super(message !== null && message !== void 0 ? message : JSON.stringify(body));
         this.status = status;
         this.body = body;
     }
     static withMessage(status, message) {
-        return new DataConnectorRunError(status, { error: message });
+        return new DataConnectorRunError(status, { error: message }, message);
     }
 }
 exports.DataConnectorRunError = DataConnectorRunError;
+/** Thrown by any failable http APIs */
+class DataConnectorRequestError extends Error {
+    constructor(status, message, response) {
+        super(message);
+        this.status = status;
+        this.response = response;
+    }
+}
+exports.DataConnectorRequestError = DataConnectorRequestError;
 /** Factory class to define a bunch of action handlers. */
 class DataConnector {
     constructor(client) {

package/sdk/dataconnector/dataconnectorclient.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MockDataConnectorClient = exports.DataConnectorClient = void 0;
 const checks_1 = require("../core/checks");
 const serializedactions_1 = require("./actions/serializedactions");
-const dataconnector_1 = require("./dataconnector");
 const datasourceclient_1 = require("./datasourceclient");
 const defaultfetchfunction_1 = require("./defaultfetchfunction");
 const signaturevalidator_1 = require("./signaturevalidator");
+const throwunsuccessful_1 = require("./throwunsuccessful");
 const LUCID_URLS = { main: 'https://lucid.app/', api: 'https://api.lucid.co/' };
 /**
  * Client for requests to and from Lucid
@@ -31,9 +31,7 @@ class DataConnectorClient {
         if (!this.cachedPublicKey) {
             const url = `${this.urls.main}.well-known/pem/TPCP`;
             const result = await this.fetchMethod(url);
-            if (Math.floor(result.status / 100) !== 2) {
-                throw new dataconnector_1.DataConnectorRunError(500, { text: await result.text(), message: 'Error getting public key' });
-            }
+            await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting public key');
             this.cachedPublicKey = await result.text();
         }
         return this.cachedPublicKey;
@@ -57,6 +55,7 @@ class DataConnectorClient {
                 'webhook-validation-secret': JSON.stringify(WebhookValidationSecret),
             },
         });
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting secret from webhook');
         const responseBody = await result.json();
         if ((0, checks_1.isString)(responseBody)) {
             return responseBody;
@@ -67,15 +66,16 @@ class DataConnectorClient {
     }
     /** @ignore */
     async getCustomWebhookData(webhookUpdateToken) {
-        return (await // todo: this should be using the public API
-         (await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
+        const result = await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
             headers: { 'data-update-token': webhookUpdateToken },
-        })).json());
+        });
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting custom webhook data');
+        return (await result.json());
     }
     /** @ignore */
     async patchCustomWebhookData(webhookUpdateToken, patch) {
         // todo: this should be using the public API
-        const response = await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
+        const result = await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
             method: 'PATCH',
             'headers': {
                 'Content-Type': 'application/json',
@@ -84,13 +84,8 @@ class DataConnectorClient {
             },
             body: JSON.stringify(patch),
         });
-        if (Math.floor(response.status / 100) !== 2) {
-            throw new dataconnector_1.DataConnectorRunError(500, {
-                message: 'Error patching custom webhook data',
-                json: await response.text(),
-            });
-        }
-        return (await response.json());
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error patching custom webhook data');
+        return (await result.json());
     }
 }
 exports.DataConnectorClient = DataConnectorClient;

package/sdk/dataconnector/datasourceclient.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MockDataSourceClient = exports.DataSourceClient = exports.serializeFieldDefinitionForApi = void 0;
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
 const object_1 = require("../core/object");
-const dataconnector_1 = require("./dataconnector");
 const defaultfetchfunction_1 = require("./defaultfetchfunction");
+const throwunsuccessful_1 = require("./throwunsuccessful");
 function serializeFieldConstraintForApi(constraint) {
     return {
         'type': constraint.type,
@@ -83,9 +83,7 @@ class DataSourceClient {
             },
             'body': JSON.stringify(this.formatBody(request)),
         });
-        if (Math.floor(response.status / 100) !== 2) {
-            throw new dataconnector_1.DataConnectorRunError(500, { message: 'Error updating data source', json: await response.text() });
-        }
+        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'Error updating data source');
         // webhooks return 200 with an empty body
         // document updates return valid json
         // we can't use .json because that will fail for webhooks

package/sdk/dataconnector/throwunsuccessful.d.ts

@@ -0,0 +1,3 @@
+import { GlobalFetchType } from './defaultfetchfunction';
+/** @ignore */
+export declare function throwUnsuccessful(result: Awaited<ReturnType<GlobalFetchType>>, message: string): Promise<void>;

package/sdk/dataconnector/throwunsuccessful.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.throwUnsuccessful = void 0;
+const dataconnector_1 = require("./dataconnector");
+/** @ignore */
+async function throwUnsuccessful(result, message) {
+    if (Math.floor(result.status / 100) !== 2) {
+        throw new dataconnector_1.DataConnectorRequestError(result.status, message, await result.text());
+    }
+}
+exports.throwUnsuccessful = throwUnsuccessful;

package/sdk/editorclient.d.ts

@@ -1,4 +1,4 @@
-import { CommandArgs, CommandName, UnionToIntersection } from './commandtypes';
+import { CommandArgs, CommandName, TriggerAuthFlowResult, UnionToIntersection } from './commandtypes';
 import { JsonSerializable } from './core/jsonserializable';
 import { UnfurlCallbacks } from './core/unfurl/unfurlcallbacks';
 import { BinaryXHRResponse, OAuthXHRRequest, TextXHRResponse, XHRRequest, XHRResponse } from './core/xhr';
@@ -115,6 +115,7 @@ export declare class EditorClient {
         responseFormat: 'binary';
     }): Promise<BinaryXHRResponse>;
     oauthXhr(providerName: string, request: OAuthXHRRequest): Promise<XHRResponse>;
+    triggerAuthFlow(providerName: string): TriggerAuthFlowResult;
     /**
      * 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

package/sdk/editorclient.js

@@ -195,6 +195,11 @@ class EditorClient {
             throw parseRawXHRResponse(responseFormat, raw);
         });
     }
+    triggerAuthFlow(providerName) {
+        return this.sendCommand("tauth" /* CommandName.TriggerAuthFlow */, {
+            'p': providerName,
+        });
+    }
     permanentTokenXhr(providerName, request) {
         const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("perm" /* CommandName.SendPermanentTokenRequest */, {