lucid-extension-sdk 0.0.186 → 0.0.187

package/commandtypes.d.ts

@@ -113,6 +113,7 @@ export declare const enum CommandName {
     SendUIMessage = "suim",
     SendXHR = "xhr",
     SetCurrentPage = "scp",
+    SetPackageSettings = "sps",
     SetProperty = "sp",
     SetReferenceKey = "srk",
     SetShapeData = "ssd",
@@ -511,6 +512,10 @@ export type CommandArgs = {
         query: SetCurrentPageQuery;
         result: SetCurrentPageResult;
     };
+    [CommandName.SetPackageSettings]: {
+        query: SetPackageSettingsQuery;
+        result: SetPackageSettingsResult;
+    };
     [CommandName.SetProperty]: {
         query: SetPropertyQuery;
         result: SetPropertyResult;
@@ -1293,6 +1298,8 @@ export type SendXHRResponse = Promise<RawSendXHRResponse>;
 export declare function isRawSendXHRResponse(val: any): val is RawSendXHRResponse;
 export type SetCurrentPageQuery = string;
 export type SetCurrentPageResult = Promise<void>;
+export type SetPackageSettingsQuery = Record<string, string>;
+export type SetPackageSettingsResult = Promise<undefined>;
 export type SetPropertyQuery = {
     /** ID of the element to change */
     'id'?: string | undefined;

package/commandtypes.js

@@ -92,6 +92,7 @@ exports.commandTitles = new Map([
     ["suim" /* CommandName.SendUIMessage */, 'SendUIMessage'],
     ["xhr" /* CommandName.SendXHR */, 'SendXHR'],
     ["scp" /* CommandName.SetCurrentPage */, 'SetCurrentPage'],
+    ["sps" /* CommandName.SetPackageSettings */, 'SetPackageSettings'],
     ["sp" /* CommandName.SetProperty */, 'SetProperty'],
     ["srk" /* CommandName.SetReferenceKey */, 'SetReferenceKey'],
     ["ssd" /* CommandName.SetShapeData */, 'SetShapeData'],

package/editorclient.d.ts

@@ -77,6 +77,15 @@ export declare class EditorClient {
      * @returns A promise that resolves when the user closes the settings modal.
      */
     showPackageSettingsModal(): Promise<void>;
+    /**
+     * If the extension package containing this editor extension has configurable settings, set the
+     * value of those settings for this installation of this extension. A subset of setting values
+     * can be provided to update those values while leaving others unchanged.
+     *
+     * If the user does not have permission to change settings on this installation of this
+     * extension, or if no settings exist, an error is thrown.
+     */
+    setPackageSettings(settings: Record<string, string> | Map<string, string>): Promise<undefined>;
     /**
      * If the extension package containing this editor extension has configurable settings,
      * fetch the current values of those settings for this installation of this extension.

package/editorclient.js

@@ -126,6 +126,26 @@ class EditorClient {
     async showPackageSettingsModal() {
         return this.sendCommand("spsm" /* CommandName.ShowPackageSettingsModal */, undefined);
     }
+    /**
+     * If the extension package containing this editor extension has configurable settings, set the
+     * value of those settings for this installation of this extension. A subset of setting values
+     * can be provided to update those values while leaving others unchanged.
+     *
+     * If the user does not have permission to change settings on this installation of this
+     * extension, or if no settings exist, an error is thrown.
+     */
+    async setPackageSettings(settings) {
+        let settingsAsRecord = {};
+        if (settings instanceof Map) {
+            for (const [key, value] of settings.entries()) {
+                settingsAsRecord[key] = value;
+            }
+        }
+        else {
+            settingsAsRecord = settings;
+        }
+        return this.sendCommand("sps" /* CommandName.SetPackageSettings */, settingsAsRecord);
+    }
     /**
      * If the extension package containing this editor extension has configurable settings,
      * fetch the current values of those settings for this installation of this extension.

package/package.json

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