lucid-extension-sdk 0.0.372 → 0.0.374

package/commandtypes.d.ts

@@ -773,6 +773,8 @@ export type AddCardIntegrationQuery = {
     'im'?: {
         /** Import Modal Heading */
         'imh'?: string;
+        /** Maximum import modal width enum value */
+        'mmw'?: number | undefined;
         /** Use Isolated Search Bar */
         'uisbui'?: boolean;
         /** Get search fields action */

package/core/cardintegration/extensionimportmodalwidthbreakpoint.d.ts

@@ -0,0 +1,20 @@
+/**
+ * These values designate the maximum width to which the import modal will expand if given the space.
+ * The import modal will remain responsive should the screen size be too small for the designated width.
+ *
+ * SMALL = 496px,
+ * MEDIUM = 656px,
+ * LARGE = 816px,
+ * XLARGE = 1344px,
+ * TINY = 296px,
+ * MLARGE (Medium Large) = 1024px
+ *
+ */
+export declare enum ExtensionImportModalWidthBreakpoint {
+    SMALL = 0,
+    MEDIUM = 1,
+    LARGE = 2,
+    XLARGE = 3,
+    TINY = 4,
+    MLARGE = 5
+}

package/core/cardintegration/extensionimportmodalwidthbreakpoint.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionImportModalWidthBreakpoint = void 0;
+/**
+ * These values designate the maximum width to which the import modal will expand if given the space.
+ * The import modal will remain responsive should the screen size be too small for the designated width.
+ *
+ * SMALL = 496px,
+ * MEDIUM = 656px,
+ * LARGE = 816px,
+ * XLARGE = 1344px,
+ * TINY = 296px,
+ * MLARGE (Medium Large) = 1024px
+ *
+ */
+var ExtensionImportModalWidthBreakpoint;
+(function (ExtensionImportModalWidthBreakpoint) {
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["SMALL"] = 0] = "SMALL";
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["MEDIUM"] = 1] = "MEDIUM";
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["LARGE"] = 2] = "LARGE";
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["XLARGE"] = 3] = "XLARGE";
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["TINY"] = 4] = "TINY";
+    ExtensionImportModalWidthBreakpoint[ExtensionImportModalWidthBreakpoint["MLARGE"] = 5] = "MLARGE";
+})(ExtensionImportModalWidthBreakpoint || (exports.ExtensionImportModalWidthBreakpoint = ExtensionImportModalWidthBreakpoint = {}));

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -215,6 +215,9 @@ class LucidCardIntegrationRegistry {
                 if (importModal.useIsolatedSearchBarUI) {
                     serialized['im']['uisbui'] = importModal.useIsolatedSearchBarUI;
                 }
+                if (importModal.maxModalWidth !== undefined) {
+                    serialized['im']['mmw'] = importModal.maxModalWidth;
+                }
                 client.registerAction(serialized['im']['gsf'], async ({ 's': searchSoFar }) => {
                     const result = await importModal.getSearchFields(new Map(searchSoFar));
                     return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);

package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts

@@ -1,5 +1,6 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { ExtensionImportModalWidthBreakpoint } from './extensionimportmodalwidthbreakpoint';
 /**
  * You can use the standard import modal can be used by providing the following data:
  *
@@ -36,6 +37,7 @@ export interface LucidCardIntegrationStandardImportModal {
      */
     importModalHeading?: string;
     useIsolatedSearchBarUI?: boolean;
+    maxModalWidth?: ExtensionImportModalWidthBreakpoint;
     getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
     search: (fields: Map<string, SerializedFieldType>) => Promise<SearchResult | SearchResult[]>;
     import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;

package/data/collectionproxy.d.ts

@@ -31,6 +31,12 @@ export declare class CollectionProxy extends PropertyStoreProxy {
      * is not a branch
      */
     getBranchedFrom(): CollectionProxy | undefined;
+    /**
+     * Certain collections, such as metadata collections, may be hidden from the data panel with the `hideFromDataPanel`
+     * argument of `CollectionPatch`. This method identifies whether this collection has been hidden from the data panel
+     * via this mechanism.
+     */
+    isHiddenFromDataPanel(): boolean;
     /**
      * @returns information about any changes made locally to the collection that have not been synchronized
      * with the external data source.

package/data/collectionproxy.js

@@ -53,6 +53,16 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
         const id = this.properties.get('BranchedFrom');
         return id ? new CollectionProxy(id, this.client) : undefined;
     }
+    /**
+     * Certain collections, such as metadata collections, may be hidden from the data panel with the `hideFromDataPanel`
+     * argument of `CollectionPatch`. This method identifies whether this collection has been hidden from the data panel
+     * via this mechanism.
+     */
+    isHiddenFromDataPanel() {
+        var _a;
+        const isHiddenFromDataPanel = (_a = this.getBranchedFrom()) === null || _a === void 0 ? void 0 : _a.properties.get('IsHiddenFromDataPanel');
+        return !!isHiddenFromDataPanel;
+    }
     /**
      * @returns information about any changes made locally to the collection that have not been synchronized
      * with the external data source.

package/package.json

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