lucid-extension-sdk 0.0.321 → 0.0.322

package/commandtypes.d.ts

@@ -31,6 +31,7 @@ export declare const enum CommandName {
     AddDiagramFromText = "adft",
     AddLineTextArea = "alta",
     AddMenuItem = "ami",
+    AddQuickAction = "aqa",
     AddShapeData = "asd",
     AddSpreadsheetIntegration = "asi",
     AddTableColumn = "atc",
@@ -191,6 +192,10 @@ export type CommandArgs = {
         query: AddMenuItemQuery;
         result: AddMenuItemResult;
     };
+    [CommandName.AddQuickAction]: {
+        query: AddQuickActionQuery;
+        result: AddQuickActionResult;
+    };
     [CommandName.AddShapeData]: {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
@@ -881,6 +886,54 @@ export type AddMenuItemQuery = {
     } | undefined;
 };
 export type AddMenuItemResult = undefined;
+export type AddQuickActionQuery = {
+    /**
+     * The type of the quick action
+     */
+    'qat': string;
+    /**
+     * The text to display on the quick action. The maximum length supported is 30 characters
+     */
+    'l': string;
+    /**
+     * Named action to run when the quick action is clicked, takes the block id as parameter.
+     * @returns true if the action was handled.
+     */
+    'a': string;
+    /**
+     * The icon to display on the quick action.
+     */
+    'i'?: string | undefined;
+    /**
+     * Named action that returns whether the quick action is enabled, takes the block id as parameter.
+     * @returns true if the Quick Action is enabled.
+     * Quick Action defaults to disabled if callback is not provided
+     */
+    'ea'?: string | undefined;
+    /**
+     * Named action that returns whether the quick action is visble in the toolbar.
+     * @returns true if the Quick Action is visible.
+     * Quick action defaults to visible in the panel if callback is not provided
+     */
+    'va'?: string | undefined;
+    /**
+     * Information on when to display tooltips and what they should say
+     */
+    'tt'?: QuickActionTooltipQuery[] | undefined;
+};
+export type QuickActionTooltipQuery = {
+    /**
+     * Named action thatreturns whether the tooltip is shown, takes the block id as parameter.
+     * @returns true if the tooltip should show
+     * Tooltip is always shown if the callback is not provided
+     */
+    'a'?: string | undefined;
+    /**
+     * The text to display on the tooltip
+     */
+    'l': string;
+};
+export type AddQuickActionResult = undefined;
 export type AddShapeDataQuery = {
     /** ID of the element to add this shape data to */
     'id'?: string | undefined;

package/commandtypes.js

@@ -10,6 +10,7 @@ exports.commandTitles = new Map([
     ["adft" /* CommandName.AddDiagramFromText */, 'AddDiagramFromText'],
     ["alta" /* CommandName.AddLineTextArea */, 'AddLineTextArea'],
     ["ami" /* CommandName.AddMenuItem */, 'AddMenuItem'],
+    ["aqa" /* CommandName.AddQuickAction */, 'AddQuickAction'],
     ["asd" /* CommandName.AddShapeData */, 'AddShapeData'],
     ["asi" /* CommandName.AddSpreadsheetIntegration */, 'AddSpreadsheetIntegration'],
     ["atc" /* CommandName.AddTableColumn */, 'AddTableColumn'],

package/core/quicktools/customquickaction.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Object that represesnts the parameters on a Custom Quick Action's callbacks
+ * @param 'id' is the id of the hooked callback
+ * @param 'bid' is the id of the block that is being interacted with
+ */
+export type CustomQuickActionCallbackParams = {
+    'id': string;
+    'bid': string;
+};
+/**
+ * Function that represents a callback to be used by the Custom Quick Action
+ */
+export type CustomQuickActionCallbackWithParams = (params: CustomQuickActionCallbackParams) => boolean;
+/**
+ * Function that represents a callback to be used by the Custom Quick Action
+ */
+export type CustomQuickActionCallback = () => boolean;
+/**
+ * A generic object to contain any information creating a quick action might need.
+ */
+export interface CustomQuickAction {
+    /**
+     * Each quick action needs a type so that we can differentiate them from the others
+     */
+    quickActionType: string;
+    /**
+     * The text to display on the quick action. The maximum length supported is 30 characters
+     */
+    label: string;
+    /**
+     * The callback to run when the quick action is clicked.
+     * @returns true if the action was handled.
+     */
+    action: CustomQuickActionCallbackWithParams;
+    /**
+     * The icon to display on the quick action.
+     * A URL (a data URI is fine) pointing to an icon representing the integration.
+     * This will be displayed at up to 24x24 pixels in size.
+     */
+    iconUrl?: string;
+    /**
+     * If specified, a callback that determines if this quick action is enabled.
+     * @returns true if the Quick Action is enabled.
+     * Quick Action defaults to disabled if callback is not provided
+     */
+    enabledAction?: CustomQuickActionCallbackWithParams | undefined;
+    /**
+     * If specified, a calback that determines if this Quick Action is visible in the menu.
+     * @returns true if the Quick Action is visible.
+     * Quick action defaults to visible in the panel if callback is not provided
+     */
+    visibleAction?: CustomQuickActionCallback | undefined;
+    /**
+     * Information on when to display tooltips and what they should say
+     */
+    tooltips?: QuickActionTooltip[];
+}
+/**
+ * A generic object to contain any information displaying a Custom Quick Action tooltip might need.
+ */
+export interface QuickActionTooltip {
+    /**
+     * If specified, a calback that determines if the tooltip should show.
+     * @returns true if the tooltip should show
+     * Tooltip is always shown if the call is not provided
+     */
+    action?: CustomQuickActionCallbackWithParams | undefined;
+    /**
+     * The text to display on the tooltip
+     */
+    label: string;
+}

package/core/quicktools/customquickaction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/quicktools/quicktools.d.ts

@@ -0,0 +1,19 @@
+import { EditorClient } from '../../editorclient';
+import { CustomQuickAction } from './customquickaction';
+/**
+ * Wrapper for Quick Tools
+ */
+export declare class QuickTools {
+    private readonly client;
+    private readonly actionTypesSet;
+    private static nextHookId;
+    private static nextHookName;
+    constructor(client: EditorClient);
+    private registerActionAndReturnHook;
+    private registerActionIfExistsAndReturnHook;
+    /**
+     * Adds the specified quick action to the quick action toolbar.
+     * @param quickAction object that represents the quick action to add.
+     */
+    addQuickActionToToolbar(quickAction: CustomQuickAction): void;
+}

package/core/quicktools/quicktools.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuickTools = void 0;
+const checks_1 = require("../checks");
+/**
+ * Wrapper for Quick Tools
+ */
+class QuickTools {
+    static nextHookName() {
+        return '__quicktools__hook' + QuickTools.nextHookId++;
+    }
+    constructor(client) {
+        this.client = client;
+        this.actionTypesSet = new Set();
+    }
+    registerActionAndReturnHook(callback) {
+        const hookname = QuickTools.nextHookName();
+        this.client.registerAction(hookname, callback);
+        return hookname;
+    }
+    registerActionIfExistsAndReturnHook(callback) {
+        if ((0, checks_1.isDef)(callback)) {
+            return this.registerActionAndReturnHook(callback);
+        }
+        return undefined;
+    }
+    /**
+     * Adds the specified quick action to the quick action toolbar.
+     * @param quickAction object that represents the quick action to add.
+     */
+    addQuickActionToToolbar(quickAction) {
+        var _a;
+        if (this.actionTypesSet.has(quickAction.quickActionType)) {
+            throw new Error('This action type already exist in this extension:' + quickAction.quickActionType);
+        }
+        this.actionTypesSet.add(quickAction.quickActionType);
+        this.client.sendCommand("aqa" /* CommandName.AddQuickAction */, {
+            'qat': quickAction.quickActionType,
+            'l': quickAction.label,
+            'a': this.registerActionAndReturnHook(quickAction.action),
+            'i': quickAction.iconUrl,
+            'ea': this.registerActionIfExistsAndReturnHook(quickAction.enabledAction),
+            'va': this.registerActionIfExistsAndReturnHook(quickAction.visibleAction),
+            'tt': (_a = quickAction.tooltips) === null || _a === void 0 ? void 0 : _a.map((tooltip) => {
+                return {
+                    'a': this.registerActionIfExistsAndReturnHook(tooltip.action),
+                    'l': tooltip.label,
+                };
+            }),
+        });
+    }
+}
+exports.QuickTools = QuickTools;
+QuickTools.nextHookId = 0;

package/package.json

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