@genexus/genexus-ide-ui 1.0.18 → 1.0.20

package/dist/types/components/navigation-report/helpers.d.ts

@@ -0,0 +1,5 @@
+import { TreeViewModel } from "@genexus/chameleon-controls-library";
+import { NavigationData } from "./navigation-report";
+export declare const STATUS_REGEXP_KEY = "status";
+export declare const CAPTION_REGEXP_KEY = "caption";
+export declare const mapNavigationDataToTreeView: (navigationData: NavigationData[]) => TreeViewModel;

package/dist/types/components/navigation-report/navigation-report.d.ts

@@ -0,0 +1,88 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { TreeViewModel } from "@genexus/chameleon-controls-library";
+export declare class GxIdeNavigationReport {
+    #private;
+    el: HTMLGxIdeNavigationReportElement;
+    reportTreeItems: TreeViewModel;
+    navigationItemsStatusRegExpString: string;
+    navigationItemsStatusRegExpStringChanged(): void;
+    navigationItemsCaptionRegExpString: string;
+    navigationItemsCaptionRegExpStringChanged(): void;
+    navigationItemsRegExp: RegExp;
+    confirmed: boolean;
+    headerState: "none" | "create" | "reorganize";
+    statusInfo: StatusInfo;
+    someStatusVisible: boolean;
+    /**
+     * The header data to display on the header.
+     */
+    readonly headerData: HeaderData;
+    /**
+     * Callback invoked when user confirms data base reorganization
+     */
+    readonly confirmCallback: ConfirmCallback;
+    /**
+     * Callback invoked when user cancels reorganization
+     */
+    readonly cancelCallback: CancelCallback;
+    /**
+     * Callback to be invoked when the user closes the dialog
+     */
+    readonly closeCallback: CloseCallback;
+    /**
+     * Callback invoked when a list item is selected
+     */
+    readonly itemSelectedCallback: ItemSelectedCallback;
+    /**
+     * @description Gets fired when the component has rendered for the first time.
+     */
+    componentDidRenderEvent: EventEmitter<string>;
+    /**
+     * Add a new item
+     */
+    addItem(item: NavigationData): Promise<void>;
+    /**
+     * Clear items
+     */
+    clearItems(): Promise<void>;
+    componentWillLoad(): Promise<void>;
+    render(): any;
+}
+export type NavigationData = {
+    id: string;
+    result: Status;
+    icon: string;
+    name: string;
+};
+export type ConfirmCallback = () => Promise<void>;
+export type CancelCallback = () => Promise<void>;
+export type CloseCallback = () => Promise<void>;
+export type ItemSelectedCallback = (id: string) => Promise<void>;
+type StatusInfo = {
+    error: {
+        display: boolean;
+        number: number;
+    };
+    warning: {
+        display: boolean;
+        number: number;
+    };
+    success: {
+        display: boolean;
+        number: number;
+    };
+};
+export type HeaderData = {
+    title: string;
+    description: string;
+    buttons: HeaderButtonData[];
+};
+export type HeaderButtonData = {
+    caption: string;
+    icon?: string;
+    type?: headerButtonType;
+    callback: () => Promise<void>;
+};
+export type headerButtonType = "button-primary" | "button-secondary";
+export type Status = "success" | "error" | "warning";
+export {};

package/dist/types/components/splash/splash.d.ts

@@ -0,0 +1,20 @@
+export declare class GxIdeUiSplash {
+    #private;
+    el: HTMLGxIdeSplashElement;
+    /**
+     * When true the slider will be visible. Used to display and hide the slide with a smooth transition.
+     */
+    splashVisible: boolean;
+    /**
+     * The copyright version. ie.: "Salto 103300"
+     */
+    readonly version: string;
+    /**
+     * If true, the splash with first disappear with a fade-out subtle effect, and then it will automatically be removed from the DOM.
+     */
+    readonly removeSplash: boolean;
+    removeSplashChanged(removeSplash: boolean): void;
+    componentWillLoad(): Promise<void>;
+    componentDidLoad(): void;
+    render(): any;
+}

package/dist/types/components/start-page/start-page.d.ts

@@ -1,82 +1,60 @@
 export declare class GxIdeStartPage {
     #private;
-    /**
-     * The component hard-coded strings translations.
-     */
-    private _componentLocale;
     el: HTMLGxIdeStartPageElement;
+    kbFilterValue: string;
+    kbFilterValueChanged(newKbFilterValue: string): void;
     /**
-     * The condition required to display the kbs filter
-     */
-    displayKbsFilter: boolean;
-    /**
-     * The condition required to display the news filter
-     */
-    displayNewsFilter: boolean;
-    /**
-     * The filtered KBs after user input
+     * The kbs after the filter value.
      */
     filteredKbs: RecentKBData[];
     /**
-     * The filtered news after user input
-     */
-    filteredNews: NewsData[];
-    /**
-     * True if kbs have been not loaded yet.
-     */
-    loadingKbs: boolean;
-    /**
-     * A list of recent news
+     * True if the start page is waiting, either for the kb's list or the secondary section.
      */
-    news: NewsData[];
-    watchNews(news: NewsData[]): void;
+    loading: boolean;
     /**
-     * The filter value for the recent news set by the user input
+     * Callback invoked to create a new KB. It must be specified whether this create is create from server or not, through the parameter 'fromServer'.
      */
-    newsFilterValue: string;
+    readonly createKBCallback: (fromServer: boolean) => Promise<void>;
     /**
-     * True if the component has been rendered for the first time.
+     * Callback invoked to open a KB when the user clicks on a KB card.
      */
-    renderedFirstTime: boolean;
+    readonly openKbCallback: (id: string) => Promise<void>;
     /**
-     * Callback invoked to load the news feed (right panel "Recent News").
+     * The secondary section that will appear below the "Create a new Knowledge Base" main section. This section will be displayed if there are no recent kbs.
      */
-    readonly getNewsCallback: GetNewsCallback;
+    readonly secondarySection?: SecondarySection;
     /**
-     * Ann array of the user's KB's
+     * User's kbs array
      */
     readonly kbs: RecentKBData[];
-    kbsChanged(kbs: RecentKBData[]): void;
+    kbsChanged(newKbs: RecentKBData[]): void;
     /**
-     * The minimum number of "kbs" that is required to display the kb's filter.
+     * The minimum required of kbs to display a filter.
      */
     readonly kbsFilterThreshold: number;
-    /**
-     * The minimum number of "news" that is required to display the news's filter.
-     */
-    readonly newsFilterThreshold: number;
-    /**
-     * Callback invoked to open a knowledge base when the user clicks on a KB card.
-     */
-    readonly openKbCallback: OpenKbCallback;
-    /**
-     * Callback invoked to open a news article.
-     */
-    readonly openNewsCallback: OpenNewsCallback;
     componentWillLoad(): Promise<void>;
-    componentDidLoad(): void;
     render(): any;
 }
-export type OpenKbCallback = (id: string) => Promise<void>;
-export type GetNewsCallback = () => Promise<NewsData[]>;
-export type OpenNewsCallback = (id: string) => Promise<void>;
 export type RecentKBData = {
-    id: string;
+    id?: string;
     name: string;
     lastOpenedDate?: Date;
+    icon: string;
+};
+export type SecondarySection = {
+    title: string;
+    cards: CardInfo[];
 };
-export type NewsData = {
-    id: string;
+export type CardInfo = {
+    icon?: {
+        src: string;
+        ariaLabel: string;
+    };
     title: string;
-    body: string;
+    description: string[];
+    action?: {
+        iconSrc: string;
+        caption: string;
+        callback?: () => void;
+    };
 };

package/dist/types/components/welcome-page/welcome-page.d.ts

@@ -0,0 +1,63 @@
+export declare class GxIdeWelcomePage {
+    #private;
+    el: HTMLGxIdeWelcomePageElement;
+    /**
+     * The current active slide index from 'slides' Prop. It does not considers the very first slide "Copyright".
+     */
+    activeSlideIndex: number;
+    /**
+     * When true the slider will be visible. Used to display and hide the slide with a smooth transition.
+     */
+    displaySlider: boolean;
+    /**
+     * True if the very first slide is visible (The copyright slide)
+     */
+    copyrightsVisible: boolean;
+    /**
+     * True if the user has reached the last slide. Used to hide/disable the navigation.
+     */
+    lastSlideReached: boolean;
+    /**
+     * When true the slider will be visible. Used to display and hide the slider with a smooth transition.
+     */
+    sliderVisible: boolean;
+    /**
+     * True if a slide is transitioning, false otherwise. Used to disable the navigation arrows while transitioning.
+     */
+    slideTransitioning: boolean;
+    /**
+     * True if the user has changed slides by clicking on the navigation dots, or by using the keyboard arrows. This is used to know evaluate the slide transition setTimeOut. If the user has navigated, automatic slide transition should be turned off.
+     */
+    userHasChangedSlide: boolean;
+    /**
+     * The transition type between the slides. "static" requires the user to navigate by clicking the navigation dots. "auto" will transition automatically after a calculated amount of time.
+     */
+    readonly transitionType: TransitionType;
+    /**
+     * The estimated amount of words per minute that the user requires to read a slide. This value is used to return the time each slide is freezed before transitioning to the next one. Only evaluated when transitionType is set to "auto".
+     */
+    readonly wordsPerMinute: number;
+    /**
+     * Callback invoked when the user closes the slider by pressing the close button.
+     */
+    readonly closeCallback: CloseCallback;
+    /**
+     * An array of slides, with the information that each slide requires. This slides appear after the first slide (Copyrights) that is defined inside the component.
+     */
+    readonly slides: SlideInfo[];
+    componentWillLoad(): Promise<void>;
+    componentDidLoad(): void;
+    render(): any;
+}
+export type SlideInfo = {
+    illustration: {
+        url: string;
+        alt: string;
+    };
+    title: string;
+    description?: string[];
+    descriptionAsChunks?: boolean;
+    listItems?: string[];
+};
+export type CloseCallback = () => Promise<void>;
+export type TransitionType = "static" | "auto";

package/dist/types/components/ww-images/helpers.d.ts

@@ -0,0 +1,3 @@
+import { ComboBoxModel } from "@genexus/chameleon-controls-library";
+import { GxOption } from "../..";
+export declare const mapOptionsToComboBoxItemModel: (options: GxOption[]) => ComboBoxModel;

package/dist/types/components/ww-images/ww-images.d.ts

@@ -1,194 +1,179 @@
 import { EventEmitter } from "../../stencil-public-runtime";
-import { GxOption } from "../../common/types";
-import { EntityData, ContextMenuInfo } from "../../common/types";
+import { ComboBoxModel } from "@genexus/chameleon-controls-library";
+import { ContextMenuInfo, EntityData, GxOption } from "../../common/types";
 export declare class GxIdeWWImages {
+    #private;
+    el: HTMLGxIdeWwImagesElement;
+    categoriesComboBoxModel: ComboBoxModel;
+    densitiesComboBoxModel: ComboBoxModel;
+    languagesComboBoxModel: ComboBoxModel;
+    layersComboBoxModel: ComboBoxModel;
+    stylesComboBoxModel: ComboBoxModel;
     /**
-     * The component hard-coded strings translations.
+     * If true the filter sidebar will be expanded, otherwise collapsed.
      */
-    private _componentLocale;
-    private renderedFirstTime;
-    private filterInitialData;
-    el: HTMLGxIdeWwImagesElement;
-    private filterEl;
-    private filterNameEl;
-    private filterSearchContentsEl;
-    private filterCategoryEl;
-    private filterModuleEl;
-    private filterModifiedEl;
-    private filterAllDescendantsEl;
-    private filterAfterTypeEl;
-    private filterUserEl;
-    private filterModifiedDateEl;
-    private filterStyleEl;
-    private filterLanguageEl;
-    private filterDensityEl;
-    private filterLayerEl;
-    private chGridEl;
-    filtersHidden: boolean;
-    filtersHiddenHandler(hidden: boolean): void;
-    /**
-     * The after types render in the after selector
-     */
-    filterAfterType: string;
-    /**
-     * For show or hide the filters relative to modifiers
+    filterSidebarExpanded: boolean;
+    /**
+     * The current value of the "After" combo box options.
      */
-    filterModified: boolean;
+    afterCurrentValue: string;
     /**
-     * The images rendered in the table
+     * The options for the "After" combo-box
      */
-    images: ImageData[];
+    filterAfterOptions: ComboBoxModel;
     /**
-     * The images rendered in the table, after the filter
+     * Images filter input value
      */
-    filteredImages: ImageData[];
+    filterImagesInputValue: string;
     /**
-     * The items of the image that is selected
+     * Shows or hides filters related to modifiers
      */
-    imagesSelectedItems: ImageItemData[];
+    filterModified: boolean;
     /**
-     * The selected images in the table of images
+     * Images rendered in the table after filtering
      */
-    selectedObjectsIds: string[];
+    filteredImages: ImageData[];
     /**
-     * The images filter input text value
+     * Images rendered in the table
      */
-    filterImagesInputValue: string;
+    images: ImageData[];
     /**
-     * If true it displays the component title on the header
+     * Items of the selected image
      */
-    readonly displayTitle = false;
+    imagesSelectedItems: ImageItemData[];
     /**
-     * Displays a secondary filter, used to filter over the filtered images
+     * Selected images in the images table
      */
-    readonly secondaryFilter = false;
+    selectedObjectsIds: string[];
+    /**
+     * If true, the "Toggle Filter" button will display activated, and the sidebar of filters
+     * will toggle on mouse enter or leave.
+     */
+    toggleFilterButtonActive: boolean;
+    toggleFilterButtonActiveChanged(active: boolean): void;
     /**
-     * The categories render in the filter category selector
+     * Categories rendered in the filter selector
      */
     readonly categories: GxOption[];
+    categoriesChanged(newCategories: GxOption[]): void;
     /**
-     * The densities render in the filter density selector
+     * Function to expand data when right-click
      */
-    readonly densities: GxOption[];
+    readonly contextMenuCallback: ContextMenuCallback;
     /**
-     * The default value for the 'categories' filter
+     * Default value for the 'categories' filter
      */
     readonly defaultCategory: string;
     /**
-     * The default value for the module/folder filter
+     * Default value for the module/folder filter
      */
     readonly defaultModule: EntityData;
     /**
-     * The default value for the type filter
+     * Function to delete the selected images.
      */
-    readonly defaultType: string;
+    readonly deleteSelectionCallback: DeleteSelectionCallback;
     /**
-     * The modules/folders render in the module/folder selector
+     * Densities rendered in the filter selector
      */
-    readonly filterModules: GxOption[];
+    readonly densities: GxOption[];
+    densitiesChanged(newDensities: GxOption[]): void;
     /**
-     * The languages render in the filter language selector
+     * Languages rendered in the filter selector
      */
     readonly languages: GxOption[];
+    languagesChanged(newLanguages: GxOption[]): void;
     /**
-     * The layers render in the filter layer selector
+     * Layers rendered in the filter selector
      */
     readonly layers: GxOption[];
+    layersChanged(newLayers: GxOption[]): void;
     /**
-     * This is a function provided by the developer for expanded the data of images that is double-clicked or entered.
-     */
-    readonly contextMenuCallback: ContextMenuCallback;
-    /**
-     * This is a function provided by the developer for expanded the data of images that is double-clicked or entered.
-     */
-    readonly deleteSelectionCallback: DeleteSelectionCallback;
-    /**
-     * This is a function provided by the developer that return a list of images to populate the table of images.
+     * Function that returns a list of images for the table
      */
     readonly loadCallback: LoadCallback;
     /**
-     * This is a function provided by the developer that return a list of items of the image selected.
+     * Function that returns a list of items for the selected image
      */
     readonly loadImageItemsCallback: LoadImageItemsCallback;
     /**
-     * This is a function provided by the developer for expanded the data of images that is double-clicked or entered.
+     * Callback invoked when user press New button.
      */
     readonly newObjectCallback: NewObjectCallback;
     /**
-     * This is a function provided by the developer for expanded the data of images that is double-clicked or entered.
+     * Function to expand data for double-clicked or entered images
      */
     readonly openSelectionCallback: OpenSelectionCallback;
     /**
-     * Callback invoked when the action is executed on the Module/Folder filter (button '...'). It returns the information of the selected object (id and name) or 'undefined' if it was canceled.
+     * Callback invoked when an action is executed on the Module/Folder filter.
      */
     readonly selectModuleCallback: SelectModuleCallback;
     /**
-     * This is a function provided by the developer for expanded the data of images that is double-clicked or entered.
+     * Callback invoked when an item is selected
      */
     readonly selectionObjectChangedCallback: SelectionObjectCallback;
+    /**
+     * Displays a secondary filter, used to filter over the filtered images
+     */
+    readonly secondaryFilter = false;
     /**
      * Applies a shadow all around
      */
     readonly shadow = false;
     /**
-     * The styles render in the filter style selector
+     * Styles rendered in the filter style selector
      */
     readonly styles: GxOption[];
+    stylesChanged(newStyles: GxOption[]): void;
     /**
-     * The types render in the filter type selector
+     * Types rendered in the filter type selector
      */
     readonly types: GxOption[];
+    connectedCallback(): Promise<void>;
     /**
-     * This event is emitted once just after the component is fully loaded and the first render() occurs.
+     * Emitted once after the component fully loads and renders for the first time.
      */
     componentDidLoadEvent: EventEmitter<boolean>;
     /**
      * @description Gets fired when the component has rendered for the first time.
      */
     componentDidRenderFirstTime: EventEmitter<string>;
-    componentWillLoad(): Promise<void>;
     componentDidLoad(): void;
     componentDidRender(): void;
+    componentWillLoad(): Promise<void>;
     keyDownHandler(eventInfo: KeyboardEvent): void;
     /**
-     * Validate necessary data input
-     */
-    validate(): Promise<boolean>;
-    /**
-     * This method reload the view, refreshing the filters and the table of images.
+     * Reloads the view, refreshing the filters and the images table.
      */
     reload(): Promise<void>;
-    private attachDetectClickOutsideFilter;
-    private removeDetectClickOutsideFilter;
-    private detectClickOutsideFilter;
-    /**
-     * @description This is needed for resetting the filter. When the user resets the filter, all the filter controls values have to be restored to the value they had on componentDidLoad.
-     */
-    private saveInitialFilterData;
-    private renderFilter;
-    private renderImagesData;
-    private renderImages;
-    private getImages;
-    private newObjectCallbackHandler;
-    private openSelectionCallBackHandler;
-    private deleteSelectionCallbackHandler;
-    private resetFilterHandler;
-    private toggleFiltersHandler;
-    private selectAll;
-    private deselectAll;
-    private listenChanges;
-    private filterInputHandler;
-    private filterImagesInformationHandler;
     render(): void;
 }
-export type SelectionObjectCallback = (ids: string[]) => Promise<void>;
-export type OpenSelectionCallback = (ids: string[]) => Promise<void>;
-export type DeleteSelectionCallback = (ids: string[]) => Promise<void>;
-export type SelectModuleCallback = () => Promise<EntityData | undefined>;
 export type ContextMenuCallback = (contextMenuInfo: ContextMenuInfo) => Promise<void>;
-export type NewObjectCallback = () => Promise<void>;
-export type LoadCallback = (filters: ImageFiltersData) => Promise<ImageData[]>;
-export type LoadImageItemsCallback = (id: string) => Promise<ImageItemData[]>;
+export type DeleteSelectionCallback = (ids: string[]) => Promise<void>;
+export type FilerInitialData = {
+    name: string;
+    module: EntityData;
+    searchContents: string;
+    category: string;
+    allDescendants: string;
+    modifiedAfter: string;
+    modifiedDateTime: string;
+    modifiedUser: string;
+    style: string;
+    language: string;
+    density: string;
+    layer: string;
+};
+export type ImageData = {
+    id: string;
+    icon: string;
+    name: string;
+    description: string;
+    parent: string;
+    module: string;
+    modifiedDate?: Date;
+    lastUser?: string;
+    importDate?: Date;
+};
 export type ImageFiltersData = {
     name?: string;
     searchContents?: string;
@@ -203,19 +188,14 @@ export type ImageFiltersData = {
     density?: string;
     layer?: string;
 };
-export type ImageData = {
-    id: string;
-    icon: string;
-    name: string;
-    description: string;
-    parent: string;
-    module: string;
-    modifiedDate?: Date;
-    lastUser?: string;
-    importDate?: Date;
-};
 export type ImageItemData = {
     id: string;
     name: string;
     url: string;
 };
+export type LoadCallback = (filters: ImageFiltersData) => Promise<ImageData[]>;
+export type LoadImageItemsCallback = (id: string) => Promise<ImageItemData[]>;
+export type NewObjectCallback = () => Promise<void>;
+export type OpenSelectionCallback = (ids: string[]) => Promise<void>;
+export type SelectModuleCallback = () => Promise<EntityData | undefined>;
+export type SelectionObjectCallback = (ids: string[]) => Promise<void>;