lucid-extension-sdk 0.0.110 → 0.0.113

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.110",
+    "version": "0.0.113",
     "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/actions/action.d.ts

@@ -102,8 +102,9 @@ export declare class Patch {
  * changes are collected in the patches field.
  **/
 export declare class DataConnectorPatchAction extends DataConnectorAction {
-    patches: Patch[];
-    constructor(context: DataConnectorActionContext, /** changes applied by Lucid */ patches: Patch[]);
+    /** changes applied by Lucid */ patches: Patch[];
+    constructor(context: DataConnectorActionContext, 
+    /** changes applied by Lucid */ patches: Patch[], name?: string);
 }
 /**
  * A description of an existing webhook that Lucid is keeping track of.

package/sdk/dataconnector/actions/action.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataConnectorManageWebhookAction = exports.Webhook = exports.DataConnectorPatchAction = exports.Patch = exports.DataConnectorSynchronousAction = exports.DataConnectorAsynchronousAction = exports.DataConnectorAction = exports.DataConnectorActionContext = void 0;
+const dataconnectoractionkeys_1 = require("./dataconnectoractionkeys");
 const patchresponsebody_1 = require("./patchresponsebody");
 /**
  * This holds all the contextual information about a give data action.
@@ -93,8 +94,9 @@ exports.Patch = Patch;
  * changes are collected in the patches field.
  **/
 class DataConnectorPatchAction extends DataConnectorAction {
-    constructor(context, /** changes applied by Lucid */ patches) {
-        super('Patch', context);
+    constructor(context, 
+    /** changes applied by Lucid */ patches, name = dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
+        super(name, context);
         this.patches = patches;
     }
 }
@@ -129,7 +131,7 @@ class DataConnectorManageWebhookAction extends DataConnectorAction {
      * created or any of these that were not deleted).
      **/
     webhooks) {
-        super('ManageWebhook', context);
+        super(dataconnectoractionkeys_1.DataConnectorActionKeys.ManageWebhook, context);
         this.webhookToken = webhookToken;
         this.webhooks = webhooks;
     }

package/sdk/dataconnector/actions/dataconnectoractionkeys.d.ts

@@ -0,0 +1,6 @@
+/** List of keys that are special kinds of actions and thus have more specific result types than just unknown */
+export declare enum DataConnectorActionKeys {
+    ManageWebhook = "ManageWebhook",
+    Patch = "Patch",
+    UnbatchedPatch = "UnbatchedPatch"
+}

package/sdk/dataconnector/actions/dataconnectoractionkeys.js

@@ -0,0 +1,10 @@
+"use strict";
+/** List of keys that are special kinds of actions and thus have more specific result types than just unknown */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataConnectorActionKeys = void 0;
+var DataConnectorActionKeys;
+(function (DataConnectorActionKeys) {
+    DataConnectorActionKeys["ManageWebhook"] = "ManageWebhook";
+    DataConnectorActionKeys["Patch"] = "Patch";
+    DataConnectorActionKeys["UnbatchedPatch"] = "UnbatchedPatch";
+})(DataConnectorActionKeys = exports.DataConnectorActionKeys || (exports.DataConnectorActionKeys = {}));

package/sdk/dataconnector/actions/patchresponsebody.d.ts

@@ -13,7 +13,7 @@ export declare class PatchChange {
     private errors;
     constructor(patchId: string, syncId: string, collections: PatchChangeCollection[]);
     setError(primaryKey: string, fieldName: string, error: string): void;
-    setToolTipError(primaryKey: string, error: string): void;
+    setTooltipError(primaryKey: string, error: string): void;
     getErrors(): Record<string, Record<string, string>>;
 }
 /** Placeholder field name for tool tip errors */

package/sdk/dataconnector/actions/patchresponsebody.js

@@ -18,7 +18,7 @@ class PatchChange {
         }
         this.errors[primaryKey][fieldName] = error;
     }
-    setToolTipError(primaryKey, error) {
+    setTooltipError(primaryKey, error) {
         this.setError(primaryKey, exports.PatchErrorTooltipField, error);
     }
     getErrors() {

package/sdk/dataconnector/actions/serializedactions.js

@@ -5,6 +5,7 @@ const dataupdatefiltertype_1 = require("../../data/dataupdatefiltertype");
 const checks_1 = require("../../core/checks");
 const validators_1 = require("../../core/validators/validators");
 const action_1 = require("./action");
+const dataconnectoractionkeys_1 = require("./dataconnectoractionkeys");
 exports.actionsHeaderValidator = (0, validators_1.objectValidator)({ 'x-lucid-rsa-nonce': checks_1.isString, 'x-lucid-signature': checks_1.isString });
 const serializedActionsBaseValidator = (0, validators_1.objectValidator)({
     'action': (0, validators_1.objectValidator)({ 'name': checks_1.isString, 'data': checks_1.isUnknown }),
@@ -17,7 +18,7 @@ const serializedActionsBaseValidator = (0, validators_1.objectValidator)({
     'documentCollections': (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
     'updateFilterType': (0, validators_1.enumValidator)(dataupdatefiltertype_1.DataUpdateFilterType),
 });
-const serializedPatchDataValidator = (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
+const serializedPatchDataValidator = (0, validators_1.objectValidator)({
     'packageVersion': checks_1.isString,
     'userCredential': checks_1.isString,
     'patches': (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
@@ -32,7 +33,13 @@ const serializedPatchDataValidator = (0, validators_1.arrayValidator)((0, valida
         }),
         'id': checks_1.isString,
     })),
-}));
+});
+const parseSerializedPatches = (patches) => {
+    return patches.map((patch) => {
+        const p = patch['patch'];
+        return new action_1.Patch(patch['id'], p['itemsAdded'], p['itemsChanged'], p['itemsDeleted'], p['syncSourceId'], p['syncCollectionId']);
+    });
+};
 const serializedManageWebhookDataValidator = (0, validators_1.objectValidator)({
     'webhooks': (0, validators_1.arrayValidator)((0, validators_1.objectValidator)({
         'documentCollections': (0, validators_1.objectOfValidator)((0, validators_1.arrayValidator)(checks_1.isString)),
@@ -47,22 +54,28 @@ function deserializeActions(client, actions) {
     }
     const name = actions['action']['name'];
     const data = actions['action']['data'];
-    if (name === 'Patch') {
-        if (!serializedPatchDataValidator(data)) {
+    if (name === dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
+        if (!(0, validators_1.arrayValidator)(serializedPatchDataValidator)(data)) {
             return;
         }
         return data.map((item) => {
             const context = new action_1.DataConnectorActionContext(actions['packageId'], item['packageVersion'], item['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
-            const patches = item['patches'].map((patch) => {
-                const p = patch['patch'];
-                return new action_1.Patch(patch['id'], p['itemsAdded'], p['itemsChanged'], p['itemsDeleted'], p['syncSourceId'], p['syncCollectionId']);
-            });
+            const patches = parseSerializedPatches(item['patches']);
             return new action_1.DataConnectorPatchAction(context, patches);
         });
     }
     if (!actions['packageVersion'] || !actions['userCredential']) {
         return;
     }
+    if (name === dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch) {
+        if (!serializedPatchDataValidator(data)) {
+            return;
+        }
+        const context = new action_1.DataConnectorActionContext(actions['packageId'], actions['packageVersion'], actions['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
+        return [
+            new action_1.DataConnectorPatchAction(context, parseSerializedPatches(data['patches']), dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch),
+        ];
+    }
     const context = new action_1.DataConnectorActionContext(actions['packageId'], actions['packageVersion'], actions['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
     if (name == 'ManageWebhook') {
         if (!serializedManageWebhookDataValidator(data)) {

package/sdk/dataconnector/dataconnector.d.ts

@@ -1,4 +1,5 @@
 import { DataConnectorAction, DataConnectorAsynchronousAction, DataConnectorManageWebhookAction, DataConnectorPatchAction, Webhook } from './actions/action';
+import { DataConnectorActionKeys } from './actions/dataconnectoractionkeys';
 import { PatchChange } from './actions/patchresponsebody';
 import { DataConnectorClient } from './dataconnectorclient';
 import { ExpressAppLike, RunDebugServerOptions } from './debugserver';
@@ -23,12 +24,7 @@ export declare class DataConnectorRunError {
     constructor(status: number, body: unknown);
     static withMessage(status: number, message: string): DataConnectorRunError;
 }
-/** List of keys that are special kinds of actions and thus have more specific result types than just unknown */
-export declare const DataConnectorActionKeys: {
-    readonly ManageWebhook: "ManageWebhook";
-    readonly Patch: "Patch";
-};
-declare type ActionTypeForName<Name extends string, Asynchronous = boolean> = Name extends typeof DataConnectorActionKeys.Patch ? ActionRequest<DataConnectorPatchAction, PatchChange[]> : Name extends typeof DataConnectorActionKeys.ManageWebhook ? ActionRequest<DataConnectorManageWebhookAction, Webhook> : ActionRequest<Asynchronous extends true ? DataConnectorAsynchronousAction : DataConnectorAction>;
+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 {
     private client;

package/sdk/dataconnector/dataconnector.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataConnector = exports.DataConnectorActionKeys = exports.DataConnectorRunError = void 0;
+exports.DataConnector = exports.DataConnectorRunError = void 0;
 const action_1 = require("./actions/action");
+const dataconnectoractionkeys_1 = require("./actions/dataconnectoractionkeys");
 const managewebhookresponsebody_1 = require("./actions/managewebhookresponsebody");
 const patchresponsebody_1 = require("./actions/patchresponsebody");
 const debugserver_1 = require("./debugserver");
@@ -17,8 +18,6 @@ class DataConnectorRunError {
     }
 }
 exports.DataConnectorRunError = DataConnectorRunError;
-/** List of keys that are special kinds of actions and thus have more specific result types than just unknown */
-exports.DataConnectorActionKeys = { ManageWebhook: 'ManageWebhook', Patch: 'Patch' };
 /** Factory class to define a bunch of action handlers. */
 class DataConnector {
     constructor(client) {
@@ -68,14 +67,14 @@ class DataConnector {
                 })();
                 responses.push(await response);
             }
-            if (actionName === exports.DataConnectorActionKeys.ManageWebhook) {
+            if (actionName === dataconnectoractionkeys_1.DataConnectorActionKeys.ManageWebhook) {
                 const response = responses[0];
                 // leave the type on this variable because our return type isn't strict. This means that
                 // changes to serializeManageWebhookResponse's return type will need to consider this point
                 const body = (0, managewebhookresponsebody_1.serializeManageWebhookResponse)(response);
                 return { status: 200, body };
             }
-            if (actionName === exports.DataConnectorActionKeys.Patch) {
+            if (actionName === dataconnectoractionkeys_1.DataConnectorActionKeys.Patch || actionName === dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch) {
                 const responsesCasted = responses;
                 // leave the type on this variable because our return type isn't strict. This means that
                 // changes to serializePatchChanges's return type will need to consider this point

package/sdk/dataconnector/dataconnectorclient.d.ts

@@ -37,10 +37,7 @@ export declare class DataConnectorClient {
     /** @ignore */
     getCustomWebhookData(webhookUpdateToken: string): Promise<JsonObject>;
     /** @ignore */
-    patchCustomWebhookData(webhookUpdateToken: string, patch: JsonObject): Promise<{
-        data: JsonObject;
-        status: number;
-    }>;
+    patchCustomWebhookData(webhookUpdateToken: string, patch: JsonObject): Promise<JsonObject>;
 }
 /** Use this for writing automated tests for your data connector */
 export declare class MockDataConnectorClient extends DataConnectorClient {

package/sdk/dataconnector/dataconnectorclient.js

@@ -51,7 +51,7 @@ class DataConnectorClient {
     /** @ignore */
     async getSecretFromWebhook(webhookUpdateToken, WebhookValidationSecret) {
         // todo: this should be using the public API
-        const result = await this.fetchMethod(`${this.urls.dataSync}/webhookAuthorization`, {
+        const result = await this.fetchMethod(`${this.urls.dataSync}webhookAuthorization`, {
             headers: {
                 'data-update-token': webhookUpdateToken,
                 'webhook-validation-secret': JSON.stringify(WebhookValidationSecret),
@@ -77,10 +77,20 @@ class DataConnectorClient {
         // todo: this should be using the public API
         const response = await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
             method: 'PATCH',
-            headers: { 'data-update-token': webhookUpdateToken },
-            body: patch,
+            'headers': {
+                'Content-Type': 'application/json',
+                'data-update-token': webhookUpdateToken,
+                'Lucid-Api-Version': '1',
+            },
+            body: JSON.stringify(patch),
         });
-        return { status: response.status, data: (await response.json()) };
+        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());
     }
 }
 exports.DataConnectorClient = DataConnectorClient;

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 */, {