@grapesjs/studio-sdk-plugins 1.0.29 → 1.0.30

package/dist/layoutSidebarButtons/types.d.ts

@@ -1,7 +1,7 @@
 import { LayoutCommandProps, LayoutConfig, RootLayoutConfig, StudioLayoutButtonConfigProps, StudioLayoutComponentsConfigProps, StudioLayoutSidebarLeftConfigProps } from '../types';
 import { PluginWithInit } from '../utils';
 import { LayoutSidebarButtonsOptions as LayoutSidebarButtonsOptionsSchema } from './typesSchema';
-export interface LayoutSidebarButtonsOptions extends Omit<LayoutSidebarButtonsOptionsSchema, 'sidebarButton' | 'rootLayout' | 'sidebarButtons'> {
+export interface LayoutSidebarButtonsOptions extends Omit<LayoutSidebarButtonsOptionsSchema, 'sidebarButton' | 'rootLayout' | 'sidebarButtons' | 'sidebarLayoutCommand'> {
     /**
      * Customize each sidebar button.
      * @example
@@ -21,6 +21,22 @@ export interface LayoutSidebarButtonsOptions extends Omit<LayoutSidebarButtonsOp
      * }
      */
     sidebarButtons?: SidebarButtonsFn;
+    /**
+     * Customize the layout command object of each sidebar button.
+     *
+     * @example
+     * sidebarLayoutCommand: ({ layoutCommand }) => {
+     *  if (layoutCommand.id === 'panelBlocks') {
+     *    // Change the default placer to absolute right
+     *    return {
+     *      ...layoutCommand,
+     *      placer: { type: 'absolute', position: 'right' }
+     *    };
+     *  }
+     *  return layoutCommand;
+     * }
+     */
+    sidebarLayoutCommand?: SidebarLayoutCommandFn;
     /**
      * Customize the root layout per breakpoint.
      */
@@ -33,25 +49,31 @@ export interface LayoutSidebarButtonsOptions extends Omit<LayoutSidebarButtonsOp
     skipLayoutConfig?: boolean;
 }
 export interface BreakpointProps extends Required<Pick<LayoutSidebarButtonsOptionsSchema, 'breakpointTablet' | 'breakpointMobile'>> {
+    breakpoint: number;
 }
 export type SidebarButtonResult = StudioLayoutComponentsConfigProps | undefined | null | false;
 export type CreateSidebarButtonFn = (props: SidebarButtonProps) => StudioLayoutButtonConfigProps;
+export interface CreateSidebarButtonOpts {
+    pluginOpts?: LayoutSidebarButtonsOptions;
+    breakpointProps: BreakpointProps;
+}
 export type SidebarButtonFn = (props: {
     id: string;
     buttonIds: typeof SidebarButtonIds;
-    breakpoint: number;
     sidebarButtonProps: SidebarButtonProps;
     buttonProps: StudioLayoutButtonConfigProps;
     createSidebarButton: (props: Partial<SidebarButtonProps>) => StudioLayoutButtonConfigProps;
 } & BreakpointProps) => SidebarButtonResult;
 export type SidebarButtonsFn = (props: {
     buttonIds: typeof SidebarButtonIds;
-    breakpoint: number;
     sidebarButtons: StudioLayoutComponentsConfigProps[];
     createSidebarButton: CreateSidebarButtonFn;
 } & BreakpointProps) => SidebarButtonResult[];
+export type SidebarLayoutCommandFn = (props: {
+    layoutCommand: LayoutCommandProps;
+    sidebarButtonProps: SidebarButtonProps;
+} & BreakpointProps) => LayoutCommandProps;
 export type CustomRootLayoutFn = (props: {
-    breakpoint: number;
     sidebarButtons: StudioLayoutComponentsConfigProps[];
     rootLayout: RootLayoutConfig;
     layoutSidebarTarget: RootLayoutConfig;
@@ -75,8 +97,9 @@ export declare enum SidebarButtonIds {
     panelGlobalStyles = "panelGlobalStyles",
     panelSidebarTabs = "panelSidebarTabs",
     panelAssets = "panelAssets",
-    aiChatPanel = "aiChatPanel"
+    aiChatPanel = "aiChatPanel",
+    dataSourceManagerPanel = "dataSourceManagerPanel"
 }
 export interface SDKPluginWithLayoutConfig extends PluginWithInit<LayoutSidebarButtonsOptions> {
-    createLayoutConfig: (options?: Pick<LayoutSidebarButtonsOptions, 'sidebarButton' | 'sidebarButtons' | 'rootLayout'>) => LayoutConfig;
+    createLayoutConfig: (options?: Pick<LayoutSidebarButtonsOptions, 'sidebarLayoutCommand' | 'sidebarButton' | 'sidebarButtons' | 'rootLayout'>) => LayoutConfig;
 }

package/dist/layoutSidebarButtons/typesSchema.d.ts

@@ -19,6 +19,22 @@ export interface LayoutSidebarButtonsOptions extends SDKPluginOptions {
      * }
      */
     sidebarButtons?: '__fn__';
+    /**
+     * Customize the layout command object of each sidebar button.
+     *
+     * @examples
+     * sidebarLayoutCommand: ({ layoutCommand }) => {
+     *  if (layoutCommand.id === 'panelBlocks') {
+     *    // Change the default placer to absolute right
+     *    return {
+     *      ...layoutCommand,
+     *      placer: { type: 'absolute', position: 'right' }
+     *    };
+     *  }
+     *  return layoutCommand;
+     * }
+     */
+    sidebarLayoutCommand?: '__fn__';
     /**
      * Customize the resultant root layout per breakpoint.
      * @examples