lucid-extension-sdk 0.0.181 → 0.0.183

package/commandtypes.d.ts

@@ -54,6 +54,7 @@ export declare const enum CommandName {
     ElementExists = "ee",
     ExecuteFormula = "ef",
     FindAvailableSpace = "fas",
+    GetOAuthClientId = "goci",
     GetConnectedLines = "gcl",
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
@@ -274,6 +275,10 @@ export type CommandArgs = {
         query: FindAvailableSpaceQuery;
         result: FindAvailableSpaceResult;
     };
+    [CommandName.GetOAuthClientId]: {
+        query: GetOAuthClientIdQuery;
+        result: GetOAuthClientIdResult;
+    };
     [CommandName.GetConnectedLines]: {
         query: GetConnectedLinesQuery;
         result: GetConnectedLinesResult;
@@ -1003,6 +1008,11 @@ export type GetOAuthTokenQuery = {
 export type GetOAuthTokenResult = Promise<string | undefined>;
 export type GetProductQuery = undefined;
 export type GetProductResult = LucidProduct;
+export type GetOAuthClientIdQuery = {
+    /** OAuth provider name as specified in the package manifest */
+    'p': string;
+};
+export type GetOAuthClientIdResult = Promise<string | undefined>;
 export type GetPropertyQuery = {
     /** ID of the LucidElement to read a property from, or undefined to read from the LucidDocument */
     'id'?: string | undefined;

package/commandtypes.js

@@ -34,6 +34,7 @@ exports.commandTitles = new Map([
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
     ["fas" /* CommandName.FindAvailableSpace */, 'FindAvailableSpace'],
+    ["goci" /* CommandName.GetOAuthClientId */, 'GetOAuthClientId'],
     ["gcl" /* CommandName.GetConnectedLines */, 'GetConnectedLines'],
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],

package/dataconnector/actions/action.d.ts

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

package/dataconnector/actions/action.js

@@ -95,9 +95,10 @@ exports.Patch = Patch;
  **/
 class DataConnectorPatchAction extends DataConnectorAction {
     constructor(context, 
-    /** changes applied by Lucid */ patches, name = dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
+    /** changes applied by Lucid */ patches, client, name = dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
         super(name, context);
         this.patches = patches;
+        this.client = client;
     }
 }
 exports.DataConnectorPatchAction = DataConnectorPatchAction;

package/dataconnector/actions/serializedactions.js

@@ -20,7 +20,6 @@ const serializedActionsBaseValidator = (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)({
         'patch': (0, validators_1.objectValidator)({
             'itemsAdded': (0, validators_1.objectOfValidator)(checks_1.isObject),
@@ -33,6 +32,8 @@ const serializedPatchDataValidator = (0, validators_1.objectValidator)({
         }),
         'id': checks_1.isString,
     })),
+    'userCredential': checks_1.isString,
+    'documentUpdateToken': checks_1.isString,
 });
 const parseSerializedPatches = (patches) => {
     return patches.map((patch) => {
@@ -61,7 +62,7 @@ function deserializeActions(client, actions) {
         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 = parseSerializedPatches(item['patches']);
-            return new action_1.DataConnectorPatchAction(context, patches);
+            return new action_1.DataConnectorPatchAction(context, patches, client.getDataSourceClient(item['documentUpdateToken']));
         });
     }
     if (!actions['packageVersion'] || !actions['userCredential']) {
@@ -73,7 +74,7 @@ function deserializeActions(client, actions) {
         }
         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),
+            new action_1.DataConnectorPatchAction(context, parseSerializedPatches(data['patches']), client.getDataSourceClient(data['documentUpdateToken']), dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch),
         ];
     }
     const context = new action_1.DataConnectorActionContext(actions['packageId'], actions['packageVersion'], actions['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);

package/editorclient.d.ts

@@ -145,6 +145,13 @@ export declare class EditorClient {
      * @returns An oauth token or undefined if it doesn't exist
      */
     getOAuthToken(providerName: string): Promise<string | undefined>;
+    /**
+     * Fetch the OAuth Client Id if there is one
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns A oauth client id or undefined if it doesn't exist
+     */
+    getOAuthClientId(providerName: string): Promise<string | undefined>;
     /**
      * 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/editorclient.js

@@ -215,6 +215,15 @@ class EditorClient {
     async getOAuthToken(providerName) {
         return await this.sendCommand("got" /* CommandName.GetOAuthToken */, { 'p': providerName });
     }
+    /**
+     * Fetch the OAuth Client Id if there is one
+     *
+     * @param providerName Name of the OAuth provider
+     * @returns A oauth client id or undefined if it doesn't exist
+     */
+    async getOAuthClientId(providerName) {
+        return await this.sendCommand("goci" /* CommandName.GetOAuthClientId */, { 'p': providerName });
+    }
     permanentTokenXhr(providerName, request) {
         const responseFormat = request.responseFormat || 'utf8';
         return this.sendCommand("perm" /* CommandName.SendPermanentTokenRequest */, {

package/package.json

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