@luminocity/lemonate-gateway 8.2.10 → 8.2.12

package/dist/index.d.ts

@@ -796,6 +796,7 @@ declare class Block extends Snapshotable {
     posY: number;
     constructor(id?: string | Snapshot | undefined, parent?: Block | undefined, type?: string | undefined, name?: string | undefined, displayName?: string | undefined, item?: PreparedItem | undefined);
     getId(): string;
+    getPositionInParent(): number;
     refreshFieldDependencies(): void;
     resetFieldValues(withChildren?: boolean): void;
     makeIdsUnique(map?: Map<string, string>, force?: boolean): Map<string, string>;
@@ -1163,6 +1164,29 @@ declare class AssetCreator {
     createAssetFromFiles(processedFiles: any[], assetBaseFolderId: string, itemData: any, forceReplace?: boolean, returnFolderInfo?: boolean): Promise<any>;
 }
 
+type PutOptions = {
+    dontCopyScripts?: boolean;
+    fieldOverrides?: any;
+    parentPosition?: number;
+};
+type SerializedBlock = {
+    type: "block";
+    item: string;
+    field: string;
+    path: string;
+    block: {
+        id: string;
+        type: string;
+        fields: any[];
+        scripts: any[];
+        children: GrabResult;
+    };
+};
+type SerializedBlocks = {
+    type: "serializedBlocks";
+    data: SerializedBlock[];
+};
+type GrabResult = string | SerializedBlocks | any[];
 declare class Serializer {
     apiClient: ApiClient;
     itemRepo: ItemRepo;
@@ -1178,7 +1202,7 @@ declare class Serializer {
      * @param {boolean} [options.omitPath] don't return path
      * @return {string|*[]}
      */
-    grab(item: PreparedItem, field: Field, blocks: Block[], options: any): string | any[] | any;
+    grab(item: PreparedItem, field: Field, blocks: Block[], options: any): GrabResult;
     /**
      * Put elements in the project
      * @param msg the data to use to create new elements in the project
@@ -1186,15 +1210,16 @@ declare class Serializer {
      * @param targetBlock the target block to put the elements in case the data contains blocks
      * @param {object} options
      * @param {boolean} [options.dontCopyScripts] if true, scripts will not be copied
-     * @param {boolean} [putOptions.fieldOverrides] if true, field overrides will be applied to new blocks
+     * @param {any} [options.fieldOverrides] object with override values for fields
+     * @param {number} [options.parentPosition] if set, specified the position index in the parent
      */
-    put(msg: any, field: Field, targetBlock: Block, options?: any): Promise<any[]>;
+    put(msg: any, field: Field, targetBlock: Block, options?: PutOptions): Promise<Block[]>;
     /**
      * Validate the clipboard message and parse it if necessary.
      * @param msg the message to be validated
      * @return {object}
      */
-    validateMessage(msg: any): any;
+    validateMessage(msg: any): SerializedBlocks;
     /**
      * Clone a block from the source block to the new parent block.
      * @param {object} srcBlock source block to grab from
@@ -1203,14 +1228,28 @@ declare class Serializer {
      * @param {PreparedItem} grabFromItem item to grab from.
      * @param {object} putOptions
      * @param {boolean} [putOptions.dontCopyScripts] if true, scripts will not be copied
-     * @param {boolean} [putOptions.fieldOverrides] if true, field overrides will be applied to new blocks
+     * @param {any} [putOptions.fieldOverrides] object with override values for fields
+     * @param {number} [putOptions.parentPosition] if set, specified the position index in the parent
      * @return {object}
      */
-    clone(srcBlock: Block, field: Field, newParentBlock: Block, grabFromItem: PreparedItem, putOptions?: any): Promise<any[]>;
+    clone(srcBlock: Block, field: Field, newParentBlock: Block, grabFromItem: PreparedItem, putOptions?: PutOptions): Promise<Block[]>;
     _updateScriptFieldReferences(oldBlockSerialized: any, newBlock: Block): void;
-    _putBlock(entry: any, field: Field, targetBlock: Block, options?: any, attachToParent?: boolean): Promise<any>;
+    /**
+     * Build unproxified subtree and only attach/proxify at the top level.
+     * We create an unproxified tree because we cannot rely on objects having been created
+     * before their block is being added to the parent. By then, the children might be created multiple times.
+     * @param entry the data to construct the new block from
+     * @param field what's the field that owns the block
+     * @param targetBlock parent block to add the new block to
+     * @param {any} options
+     * @param {boolean} [putOptions.dontCopyScripts] if true, scripts will not be copied
+     * @param {any} [putOptions.fieldOverrides] object with override values for fields
+     * @param {number} [putOptions.parentPosition] if set, specified the position index in the parent
+     * @param attachToParent
+     */
+    _putBlock(entry: SerializedBlock, field: Field, targetBlock: Block, options?: PutOptions, attachToParent?: boolean): Promise<Block | null>;
     _createUnproxifiedBlock(type: string, fieldOverrides: any, scriptsData: any[], field: Field, ownerItem: PreparedItem): Promise<Block | null>;
-    _proxifyAndAttachTree(root: Block, parent: Block, ownerItem: PreparedItem): any;
+    _proxifyAndAttachTree(root: Block, parent: Block, ownerItem: PreparedItem, parentPosition?: number): Block;
     _findItemById(id: string): PreparedItem | undefined;
     _findItemField(item: PreparedItem, fieldName: string): Field | null;
     _findParentBlock(item: PreparedItem, fieldName: string, path: string): Block | null;