lucid-extension-sdk 0.0.245 → 0.0.246

package/commandtypes.d.ts

@@ -45,6 +45,7 @@ export declare const enum CommandName {
     CreateCollection = "cc",
     CreateDataSource = "cds",
     CreateDocumentElement = "cde",
+    CreateGroup = "cg",
     CreateLine = "cl",
     CreatePage = "cp",
     CreateUserImage = "cui",
@@ -241,6 +242,10 @@ export type CommandArgs = {
         query: CreateDocumentElementQuery;
         result: CreateDocumentElementResult;
     };
+    [CommandName.CreateGroup]: {
+        query: CreateGroupQuery;
+        result: CreateGroupResult;
+    };
     [CommandName.CreateLine]: {
         query: CreateLineQuery;
         result: CreateLineResult;
@@ -886,6 +891,16 @@ export type CreateBlockQuery = {
     's'?: JsonSerializable | undefined;
 };
 export type CreateBlockResult = string;
+export type CreateGroupQuery = {
+    /**
+     * By default, we add the group to the current page & currently active group. If specified, the
+     * group will instead be created as a direct child of the given page.
+     */
+    'p'?: string | undefined;
+    /** List of item IDs to group */
+    'i': string[];
+};
+export type CreateGroupResult = string;
 export type CreateCollectionFieldDefinition = {
     /** Name of the field */
     'n': string;

package/commandtypes.js

@@ -23,6 +23,7 @@ exports.commandTitles = new Map([
     ["cc" /* CommandName.CreateCollection */, 'CreateCollection'],
     ["cds" /* CommandName.CreateDataSource */, 'CreateDataSource'],
     ["cde" /* CommandName.CreateDocumentElement */, 'CreateDocumentElement'],
+    ["cg" /* CommandName.CreateGroup */, 'CreateGroup'],
     ["cl" /* CommandName.CreateLine */, 'CreateLine'],
     ["cp" /* CommandName.CreatePage */, 'CreatePage'],
     ["die" /* CommandName.DataItemExists */, 'DataItemExists'],

package/document/pageproxy.d.ts

@@ -86,6 +86,13 @@ export declare class PageProxy extends ElementProxy {
      * @returns The added block
      */
     addBlock(def: BlockDefinition): BlockProxy;
+    /**
+     * Creates a new group from a list of items.
+     *
+     * @param blocks A non-empty array of items to group
+     * @returns The added group
+     */
+    groupBlocks(blocks: BlockProxy[]): GroupProxy;
     /**
      * Add a new line to this page.
      * @param def The definition of the new line to add

package/document/pageproxy.js

@@ -128,6 +128,19 @@ class PageProxy extends elementproxy_1.ElementProxy {
         }
         return block;
     }
+    /**
+     * Creates a new group from a list of items.
+     *
+     * @param blocks A non-empty array of items to group
+     * @returns The added group
+     */
+    groupBlocks(blocks) {
+        const id = this.client.sendCommand("cg" /* CommandName.CreateGroup */, {
+            'p': this.id,
+            'i': blocks.map((block) => block.id),
+        });
+        return new groupproxy_1.GroupProxy(id, this.client);
+    }
     /**
      * Add a new line to this page.
      * @param def The definition of the new line to add

package/package.json

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