lucid-extension-sdk 0.0.134 → 0.0.136

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -63,6 +63,7 @@ export declare const enum CommandName {
     GetSelection = "gs",
     GetShapeData = "gsd",
     GetTextStyle = "gts",
+    GetVisibleRect = "gvr",
     HideModal = "hm",
     HidePanel = "hp",
     HookCreateItems = "hci",
@@ -295,6 +296,10 @@ export declare type CommandArgs = {
         query: GetTextStyleQuery;
         result: GetTextStyleResult;
     };
+    [CommandName.GetVisibleRect]: {
+        query: GetVisibleRectQuery;
+        result: GetVisibleRectResult;
+    };
     [CommandName.HideModal]: {
         query: HideModalQuery;
         result: HideModalResult;
@@ -534,6 +539,8 @@ export declare type AddCardIntegrationQuery = {
         's': string;
         /** Import action */
         'i': string;
+        /** OnSetup action */
+        'os'?: string | undefined;
     } | undefined;
     /** If specified, add-card settings */
     'ac'?: {
@@ -889,6 +896,8 @@ export declare type GetTextStyleQuery = {
     'n': string;
 };
 export declare type GetTextStyleResult = TextStyle;
+export declare type GetVisibleRectQuery = void;
+export declare type GetVisibleRectResult = Box;
 export declare type HideModalQuery = {
     /** Name of the modal's action for receiving events, i.e. ShowModalQuery['n'] */
     'n': string;

package/sdk/commandtypes.js

@@ -45,6 +45,7 @@ exports.commandTitles = new Map([
     ["gs" /* CommandName.GetSelection */, 'GetSelection'],
     ["gsd" /* CommandName.GetShapeData */, 'GetShapeData'],
     ["gts" /* CommandName.GetTextStyle */, 'GetTextStyle'],
+    ["gvr" /* CommandName.GetVisibleRect */, 'GetVisibleRect'],
     ["hm" /* CommandName.HideModal */, 'HideModal'],
     ["hp" /* CommandName.HidePanel */, 'HidePanel'],
     ["hci" /* CommandName.HookCreateItems */, 'HookCreateItems'],

package/sdk/core/cardintegration/lucidcardintegration.d.ts

@@ -91,6 +91,10 @@ export declare abstract class LucidCardIntegration {
      * The user checked the boxes beside the given list of items in the collection returned from search().
      * Import them, and return the collection and primary keys in that final collection that were imported.
      *
+     * onSetup:
+     * If specified, it's going to be called everytime the modal is setting up, right after the modal is displayed
+     * and before the initial form fields are shown to the user.
+     *
      * The config provided here is only used on the first import from a given source; on subsequent imports,
      * the existing config will remain unchanged to preserve any customizations by the user.
      */
@@ -108,6 +112,7 @@ export declare abstract class LucidCardIntegration {
             collection: CollectionProxy;
             primaryKeys: string[];
         }>;
+        onSetup?: () => Promise<void>;
     };
     /**
      * If specified, allow the user to create new cards and convert other shapes to cards

package/sdk/core/cardintegration/lucidcardintegrationregistry.js

@@ -77,6 +77,7 @@ class LucidCardIntegrationRegistry {
                 'gsf': LucidCardIntegrationRegistry.nextHookName(),
                 's': LucidCardIntegrationRegistry.nextHookName(),
                 'i': LucidCardIntegrationRegistry.nextHookName(),
+                'os': importModal.onSetup ? LucidCardIntegrationRegistry.nextHookName() : undefined,
             };
             client.registerAction(serialized['im']['gsf'], async ({ 's': searchSoFar }) => {
                 const result = await importModal.getSearchFields(new Map(searchSoFar));
@@ -100,6 +101,12 @@ class LucidCardIntegrationRegistry {
                     'pks': result.primaryKeys,
                 };
             });
+            if (serialized['im']['os']) {
+                client.registerAction(serialized['im']['os'], async () => {
+                    var _a;
+                    await ((_a = importModal.onSetup) === null || _a === void 0 ? void 0 : _a.call(importModal));
+                });
+            }
         }
         if (cardIntegration.addCard) {
             const addCard = cardIntegration.addCard;

package/sdk/ui/viewport.d.ts

@@ -30,6 +30,10 @@ export declare class Viewport {
      * @param page The page to view
      */
     setCurrentPage(page: PageProxy): void;
+    /**
+     * @returns the box for the current viewport location
+     */
+    getVisibleRect(): import("../math").Box;
     /**
      * Switch to the page containing these items, if necessary, and then animate the viewport
      * to zoom in and focus on these items.

package/sdk/ui/viewport.js

@@ -37,6 +37,12 @@ class Viewport {
     setCurrentPage(page) {
         this.client.sendCommand("scp" /* CommandName.SetCurrentPage */, page.id);
     }
+    /**
+     * @returns the box for the current viewport location
+     */
+    getVisibleRect() {
+        return this.client.sendCommand("gvr" /* CommandName.GetVisibleRect */, undefined);
+    }
     /**
      * Switch to the page containing these items, if necessary, and then animate the viewport
      * to zoom in and focus on these items.