{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./entities/entities" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./entities/smartFormModal" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./list" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./utils" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./main/index" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./types" } } ] }, { "kind": "javascript-module", "path": "src/types.ts", "declarations": [ { "kind": "variable", "name": "RESOURCE_NAME" }, { "kind": "variable", "name": "ENTITY_NAME" } ], "exports": [ { "kind": "js", "name": "RESOURCE_NAME", "declaration": { "name": "RESOURCE_NAME", "module": "src/types.ts" } }, { "kind": "js", "name": "ENTITY_NAME", "declaration": { "name": "ENTITY_NAME", "module": "src/types.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/components.ts", "declarations": [ { "kind": "function", "name": "loadRemotes" } ], "exports": [ { "kind": "js", "name": "loadRemotes", "declaration": { "name": "loadRemotes", "module": "src/components/components.ts" } } ] }, { "kind": "javascript-module", "path": "src/components/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./components" } } ] }, { "kind": "javascript-module", "path": "src/entities/entities.styles.ts", "declarations": [ { "kind": "variable", "name": "styles", "default": "css`\n :host {\n contain: content;\n }\n\n :host::part(header) {\n display: flex;\n justify-content: space-between;\n align-items: center;\n user-select: none;\n padding: 0 calc(var(--design-unit) * 2px);\n }\n\n .header-title {\n color: var(--neutral-foreground-rest);\n font-size: var(--type-ramp-plus-4-font-size);\n font-family: var(--body-font);\n font-weight: 700;\n padding: 0 calc(var(--design-unit) * 2px);\n }\n\n :host::part(before-header),\n :host::part(before-footer) {\n justify-content: flex-start;\n }\n\n :host::part(header),\n :host::part(footer) {\n margin-left: auto;\n }\n\n :host::part(header),\n :host::part(after-header),\n :host::part(footer),\n :host::part(after-footer) {\n display: flex;\n user-select: none;\n }\n\n div.footer-container {\n display: flex;\n align-items: center;\n }\n\n div.header-container {\n display: flex;\n align-items: center;\n }\n\n slot[name='before-header']:not(:has(::slotted(*))),\n slot[name='after-header']:not(:has(::slotted(*))),\n slot[name='before-footer']:not(:has(::slotted(*))),\n slot[name='after-footer']:not(:has(::slotted(*))) {\n display: none;\n }\n\n :host::part(after-header),\n :host::part(after-footer) {\n justify-content: flex-end;\n }\n\n :host([modal-position='centre']) .edit-modal {\n overflow-y: auto;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: 100%;\n }\n\n foundation-form {\n min-height: 400px;\n height: 100%;\n overflow-y: auto;\n display: flex;\n flex-direction: column;\n justify-content: space-between;\n }\n\n .title {\n margin-left: 1px;\n }\n\n .search-container {\n display: flex;\n align-items: center;\n gap: calc(var(--design-unit) * 2px);\n flex: 1;\n justify-content: flex-end;\n }\n\n .search-container zero-search-bar,\n .search-container rapid-search-bar {\n width: 500px;\n margin-left: calc(var(--design-unit) * 4px);\n }\n\n .custom-buttons,\n .crud-buttons {\n display: flex;\n gap: calc(var(--design-unit) * 2px);\n }\n\n .custom-buttons-wrapper,\n .crud-buttons-wrapper {\n display: flex;\n gap: calc(var(--design-unit) * 2px);\n justify-content: flex-end;\n }\n\n .custom-buttons-wrapper-column,\n .custom-buttons-wrapper-top,\n .crud-buttons-wrapper-column,\n .crud-buttons-wrapper-top {\n padding: calc(var(--design-unit) * 2px) 0;\n }\n\n .crud-buttons-wrapper-bottom {\n padding: calc(var(--design-unit) * 2px);\n }\n\n .custom-buttons-wrapper-bottom {\n padding: calc(var(--design-unit) * 2px) 0;\n }\n\n .filter-button {\n margin-left: calc(var(--design-unit) * 2px);\n }\n\n .main-content {\n height: 100%;\n display: flex;\n }\n\n .filters-modal {\n overflow-y: auto;\n }\n\n .filters-modal foundation-filters {\n min-height: 400px;\n height: 100%;\n display: flex;\n flex-direction: column;\n }\n\n .grid-content-area {\n display: flex;\n flex-direction: column;\n flex: 1;\n height: 100%;\n }\n`", "description": "Defines the css of the entity component as an ElementStyles object" } ], "exports": [ { "kind": "js", "name": "styles", "declaration": { "name": "styles", "module": "src/entities/entities.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/entities/entities.template.ts", "declarations": [ { "kind": "function", "name": "crudButtonsTemplate", "parameters": [ { "name": "prefix", "type": { "text": "string" } }, { "name": "position", "type": { "text": "CrudMenuPosition" } } ], "description": "Default crud buttons for Entity Management screen (CRUD only, no custom actions)" }, { "kind": "function", "name": "exportHeader", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ] }, { "kind": "function", "name": "getPrefixedEntities", "parameters": [ { "name": "prefix", "type": { "text": "string" } } ], "description": "Defines the html of the entity component as a ViewTemplate object" } ], "exports": [ { "kind": "js", "name": "crudButtonsTemplate", "declaration": { "name": "crudButtonsTemplate", "module": "src/entities/entities.template.ts" } }, { "kind": "js", "name": "exportHeader", "declaration": { "name": "exportHeader", "module": "src/entities/entities.template.ts" } }, { "kind": "js", "name": "getPrefixedEntities", "declaration": { "name": "getPrefixedEntities", "module": "src/entities/entities.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/entities/entities.ts", "declarations": [ { "kind": "function", "name": "getActionNotificationTitleAndBody", "parameters": [ { "name": "type", "type": { "text": "ModalFormType | CrudAction.Delete | string" }, "description": "The type of action performed (Create, Update, Delete, etc.)" }, { "name": "label", "type": { "text": "string" }, "description": "The label of the entity being managed." } ], "description": "Returns the title and body for a notification based on the action type and entity label.", "return": { "type": { "text": "" } } }, { "kind": "class", "description": "Main class which defines the entity management functionality", "name": "EntityManagement", "members": [ { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "'rapid'", "description": "Name of the design system prefix that will be used in renderers.", "privacy": "public" }, { "kind": "field", "name": "resourceName", "type": { "text": "string" }, "description": "Name of the backend resource which contain the entities to manage", "privacy": "public" }, { "kind": "field", "name": "readEvent", "type": { "text": "string" }, "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity", "privacy": "public" }, { "kind": "field", "name": "readEventFn", "type": { "text": "(entity) => any" }, "description": "Similar to readEvent but allows to provide function that will be executed before\nopening the form and yields data to the form", "parameters": [ { "description": "selected entity from the grid", "name": "entity" } ], "return": { "type": { "text": "" } }, "privacy": "public" }, { "kind": "field", "name": "updateEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles updating the entity", "privacy": "public" }, { "kind": "field", "name": "deleteEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles deleting the entity", "privacy": "public" }, { "kind": "field", "name": "createEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles creating an entity", "privacy": "public" }, { "kind": "field", "name": "errorNotificationConfig", "type": { "text": "NotificationStructure['config']" }, "default": "{\n snackbar: { type: 'error' },\n }", "description": "Notification config used for submit failures. Defaults to an error snackbar but can be\noverridden while keeping title/body unchanged.", "privacy": "public" }, { "kind": "field", "name": "successNotificationTitle", "type": { "text": "string" }, "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.", "privacy": "public" }, { "kind": "field", "name": "successNotificationBody", "type": { "text": "string" }, "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.", "privacy": "public" }, { "kind": "field", "name": "title", "type": { "text": "string" }, "description": "Title of the grid", "privacy": "public" }, { "kind": "field", "name": "entityLabel", "type": { "text": "string" }, "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications", "privacy": "public" }, { "kind": "field", "name": "createLabel", "type": { "text": "string" }, "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.", "privacy": "public" }, { "kind": "field", "name": "rowSelection", "type": { "text": "string" }, "default": "'single'", "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.", "privacy": "public" }, { "kind": "field", "name": "enableCellFlashing", "type": { "text": "boolean" }, "default": "false", "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef", "privacy": "public" }, { "kind": "field", "name": "enableRowFlashing", "type": { "text": "boolean" }, "default": "false", "description": "If true, will enable row flashing for all rows for `add` transactions", "privacy": "public" }, { "kind": "field", "name": "datasourceType", "type": { "text": "DatasourceType" }, "default": "'client'", "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.", "privacy": "public" }, { "kind": "field", "name": "persistColumnStateKey", "type": { "text": "string" }, "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.", "privacy": "public" }, { "kind": "field", "name": "persistFilterModelKey", "type": { "text": "string" }, "description": "The key to use for persisting the filter model in local browser or KV storage.", "privacy": "public" }, { "kind": "field", "name": "gridOptions", "type": { "text": "GridOptionsConfig" }, "description": "GridOptions to be passed down from application", "privacy": "public" }, { "kind": "field", "name": "statusBarConfig", "type": { "text": "GridProStatusBarConfig" }, "description": "Configuration for the grid status bar components.", "privacy": "public" }, { "kind": "field", "name": "columns", "type": { "text": "GridColDef[]" }, "description": "Array which holds the column definitions.", "privacy": "public" }, { "kind": "field", "name": "createFormUiSchema", "type": { "text": "UiSchema" }, "description": "Enables you to supply a schema to configure an insert form.", "privacy": "public" }, { "kind": "field", "name": "updateFormUiSchema", "type": { "text": "UiSchema" }, "description": "Enables you to supply a schema to configure an update form.", "privacy": "public" }, { "kind": "field", "name": "formRenderers", "type": { "text": "RendererEntry[]" }, "default": "renderers", "description": "Array with renderers used by foundation-forms", "privacy": "public" }, { "kind": "field", "name": "additionalFormRenderers", "type": { "text": "RendererEntry[]" }, "default": "[]", "description": "Additional renderer entries to append to the form renderer registry.\nUse this to supply custom UI schema renderers without replacing defaults.", "privacy": "public" }, { "kind": "field", "name": "customActions", "type": { "text": "CustomAction[]" }, "default": "[]", "description": "Array of custom actions that can be added to the entity management component", "privacy": "public" }, { "kind": "field", "name": "confirmationMessage", "type": { "text": "string" }, "description": "Optional confirmation message to display before form submission.\nIf set, a confirmation dialog will be shown when the user clicks submit.", "privacy": "public" }, { "kind": "field", "name": "setApprovalMessage", "type": { "text": "boolean" }, "description": "When enabled, adds an APPROVAL_MESSAGE field to the form schema.\nThis field will be sent at root level alongside DETAILS when submitting.\nCan be overridden per custom action via the action's setApprovalMessage property.", "privacy": "public" }, { "kind": "field", "name": "approvalMessageLabel", "type": { "text": "string" }, "default": "'Approval Message'", "description": "Label for the approval message field in the approval dialog.", "privacy": "public" }, { "kind": "field", "name": "defaultEntityValues", "type": { "text": "Record" }, "description": "The default values to populate the form with when the user is adding an entity", "privacy": "public" }, { "kind": "method", "name": "editModalVisibleChanged", "privacy": "private" }, { "kind": "field", "name": "sizeColumnsToFit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "privacy": "public" }, { "kind": "field", "name": "sizeColumnsToContent", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "privacy": "public" }, { "kind": "field", "name": "gridAutosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "privacy": "public" }, { "kind": "field", "name": "enableFilterBar", "type": { "text": "boolean" }, "description": "Enables filter bar component", "privacy": "public" }, { "kind": "field", "name": "hideEdit", "type": { "text": "boolean" }, "default": "false", "description": "Hides edit button", "privacy": "public" }, { "kind": "field", "name": "hideDelete", "type": { "text": "boolean" }, "default": "false", "description": "Hides delete button", "privacy": "public" }, { "kind": "field", "name": "enableSearchBar", "type": { "text": "boolean" }, "default": "false", "description": "This attribute controls whether to enable the search-bar.", "privacy": "public" }, { "kind": "field", "name": "enableAiCriteriaSearch", "type": { "text": "boolean" }, "default": "false", "description": "Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.", "privacy": "public" }, { "kind": "field", "name": "headerCaseType", "type": { "text": "GridProCaseType" }, "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.", "privacy": "public" }, { "kind": "field", "name": "searchBarConfig", "type": { "text": "AvailableOption[]" }, "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @public" }, { "kind": "field", "name": "gridVisible", "type": { "text": "boolean" }, "default": "true", "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @internal" }, { "kind": "field", "name": "enableFilters", "type": { "text": "boolean" }, "default": "false", "description": "Enables foundation-filters with flyout UI", "privacy": "public" }, { "kind": "field", "name": "filtersUiSchema", "type": { "text": "UiSchema" }, "description": "UI schema configuration for the filters component", "privacy": "public" }, { "kind": "field", "name": "showFilterPersistenceControls", "type": { "text": "boolean" }, "default": "true", "description": "Controls visibility of filter save/load UI in foundation-filters", "privacy": "public" }, { "kind": "method", "name": "filtersModalVisibleChanged", "privacy": "private" }, { "kind": "field", "name": "modalPosition", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'right'", "description": "Determines where the modal dialog will appear on screen", "privacy": "public" }, { "kind": "field", "name": "filtersModalPosition", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'left'", "description": "Determines where the filters modal will appear on screen", "privacy": "public" }, { "kind": "field", "name": "crudMenuPosition", "type": { "text": "CrudMenuPosition" }, "description": "Determines where the buttons will appear", "privacy": "public" }, { "kind": "field", "name": "crudMenuStyle", "type": { "text": "ActionsMenuStyle" }, "description": "Determines the style of the buttons", "privacy": "public" }, { "kind": "field", "name": "crudActionMenuName", "type": { "text": "string" }, "default": "'⋮'", "description": "The label of the crud action menu" }, { "kind": "field", "name": "enableCsvExport", "type": { "text": "{ buttonName?: string; fileName?: string } | null" }, "default": "null", "description": "Enabling this option will enable a download button in the top-right of the header which will export the data to a csv file when clicked." }, { "kind": "field", "name": "setBaseCriteria", "type": { "text": "boolean" }, "privacy": "private", "default": "true", "description": "Flag which can be used to control when to cache the base criteria when the datasourceConfig changes\n(we don't want to cache in the case we've set a criteria via the search bar)" }, { "kind": "field", "name": "datasourceConfig", "description": "Get the configuration which is used when interacting with the resource on the backend", "privacy": "public" }, { "kind": "method", "name": "setDSConfigWithoutUpdatingBaseCriteria", "parameters": [ { "name": "config", "type": { "text": "DatasourceConfiguration" } } ], "description": "Usually when the datasource config is updated we need to cache the criteria\nso it can be combined with the searchbar, but this function allows you to set\nthe datasource config without doing that (so we don't cache the search bar\ncriteria)" }, { "kind": "method", "name": "readEntity", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "searchBarReqServer", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "SelectedOption[]" } } ] }, { "kind": "method", "name": "searchBarDataserver", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "SelectedOption[]" } } ] }, { "kind": "method", "name": "requestChanged", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "filtersCriteriaChanged", "privacy": "private" }, { "kind": "method", "name": "criteriaChanged", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "updateCombinedCriteria", "privacy": "private" }, { "kind": "method", "name": "submitFailureNotification", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "submitErrorHandler", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "showDeleteConfirmation", "privacy": "private" }, { "kind": "method", "name": "deleteColumnState", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "resetToDefault", "default": "true", "type": { "text": "boolean" }, "description": "Whether to reset columns to their default configuration. Defaults to true." } ], "description": "Deletes the saved column state for the grid" }, { "kind": "method", "name": "cleanupConfirmationDialog", "privacy": "private", "description": "Ensure any confirmation dialog anchored to the modal boundary is closed/removed" } ], "events": [ { "description": "Fired when the request is changed. detail: `Record | null`", "name": "request-changed" }, { "description": "Fired when the criteria is changed. detail: `string | null`", "name": "criteria-changed" }, { "description": "Fired when an entity is created", "name": "create-entity" }, { "description": "Fired when an entity is edited", "name": "edit-entity" }, { "description": "Fired when an entity is deleted Bubbled events from the child entity-list component", "name": "delete-entity" }, { "description": "Fired when there is an error in a create, edit or delete operation. detail: `SubmitFailureEventDetail`", "name": "submit-failure" }, { "description": "Fired when a create, edit or delete operation is completed successfully. detail: `SubmitSuccessEventDetail`", "name": "submit-success" }, { "description": "Fired when a row is clicked. detail: `Record | undefined`", "name": "rowClick" }, { "description": "Fired when a row is double clicked. detail: `Record | undefined`", "name": "rowDblClick" }, { "description": "Fired when a row is right clicked. detail: `Record | undefined`", "name": "contextMenu" }, { "description": "Fired when a row is selected. detail: `RowSelectedEvent`", "name": "rowSelected" }, { "description": "Fired when grid selection changes (bubbled from entity-list). detail: `SelectionChangedEvent`", "name": "selectionChanged" } ], "attributes": [ { "name": "design-system-prefix", "type": { "text": "string" }, "default": "'rapid'", "description": "Name of the design system prefix that will be used in renderers.", "fieldName": "prefix" }, { "name": "resourceName", "type": { "text": "string" }, "description": "Name of the backend resource which contain the entities to manage", "fieldName": "resourceName" }, { "name": "readEvent", "type": { "text": "string" }, "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity", "fieldName": "readEvent" }, { "name": "updateEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles updating the entity", "fieldName": "updateEvent" }, { "name": "deleteEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles deleting the entity", "fieldName": "deleteEvent" }, { "name": "createEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles creating an entity", "fieldName": "createEvent" }, { "name": "success-notification-title", "type": { "text": "string" }, "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.", "fieldName": "successNotificationTitle" }, { "name": "success-notification-body", "type": { "text": "string" }, "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.", "fieldName": "successNotificationBody" }, { "name": "title", "type": { "text": "string" }, "description": "Title of the grid", "fieldName": "title" }, { "name": "entityLabel", "type": { "text": "string" }, "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications", "fieldName": "entityLabel" }, { "name": "create-label", "type": { "text": "string" }, "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.", "fieldName": "createLabel" }, { "name": "row-selection", "type": { "text": "string" }, "default": "'single'", "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.", "fieldName": "rowSelection" }, { "name": "enable-cell-flashing", "type": { "text": "boolean" }, "default": "false", "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef", "fieldName": "enableCellFlashing" }, { "name": "enable-row-flashing", "type": { "text": "boolean" }, "default": "false", "description": "If true, will enable row flashing for all rows for `add` transactions", "fieldName": "enableRowFlashing" }, { "name": "datasource-type", "type": { "text": "DatasourceType" }, "default": "'client'", "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.", "fieldName": "datasourceType" }, { "name": "persist-column-state-key", "type": { "text": "string" }, "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.", "fieldName": "persistColumnStateKey" }, { "name": "persist-filter-model-key", "type": { "text": "string" }, "description": "The key to use for persisting the filter model in local browser or KV storage.", "fieldName": "persistFilterModelKey" }, { "name": "confirmation-message", "type": { "text": "string" }, "description": "Optional confirmation message to display before form submission.\nIf set, a confirmation dialog will be shown when the user clicks submit.", "fieldName": "confirmationMessage" }, { "name": "set-approval-message", "type": { "text": "boolean" }, "description": "When enabled, adds an APPROVAL_MESSAGE field to the form schema.\nThis field will be sent at root level alongside DETAILS when submitting.\nCan be overridden per custom action via the action's setApprovalMessage property.", "fieldName": "setApprovalMessage" }, { "name": "approval-message-label", "type": { "text": "string" }, "default": "'Approval Message'", "description": "Label for the approval message field in the approval dialog.", "fieldName": "approvalMessageLabel" }, { "name": "size-columns-to-fit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "fieldName": "sizeColumnsToFit" }, { "name": "size-columns-to-content", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "fieldName": "sizeColumnsToContent" }, { "name": "grid-autosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "fieldName": "gridAutosizing" }, { "name": "enable-filter-bar", "type": { "text": "boolean" }, "description": "Enables filter bar component", "fieldName": "enableFilterBar" }, { "name": "hide-edit", "type": { "text": "boolean" }, "default": "false", "description": "Hides edit button", "fieldName": "hideEdit" }, { "name": "hide-delete", "type": { "text": "boolean" }, "default": "false", "description": "Hides delete button", "fieldName": "hideDelete" }, { "name": "enable-search-bar", "type": { "text": "boolean" }, "default": "false", "description": "This attribute controls whether to enable the search-bar.", "fieldName": "enableSearchBar" }, { "name": "enable-ai-criteria-search", "type": { "text": "boolean" }, "default": "false", "description": "Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.", "fieldName": "enableAiCriteriaSearch" }, { "name": "header-case-type", "type": { "text": "GridProCaseType" }, "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.", "fieldName": "headerCaseType" }, { "name": "enable-filters", "type": { "text": "boolean" }, "default": "false", "description": "Enables foundation-filters with flyout UI", "fieldName": "enableFilters" }, { "name": "show-filter-persistence-controls", "type": { "text": "boolean" }, "default": "true", "description": "Controls visibility of filter save/load UI in foundation-filters", "fieldName": "showFilterPersistenceControls" }, { "name": "modal-position", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'right'", "description": "Determines where the modal dialog will appear on screen", "fieldName": "modalPosition" }, { "name": "filters-modal-position", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'left'", "description": "Determines where the filters modal will appear on screen", "fieldName": "filtersModalPosition" }, { "name": "crud-menu-position", "type": { "text": "CrudMenuPosition" }, "description": "Determines where the buttons will appear", "fieldName": "crudMenuPosition" }, { "name": "crud-menu-style", "type": { "text": "ActionsMenuStyle" }, "description": "Determines the style of the buttons", "fieldName": "crudMenuStyle" }, { "name": "crud-action-menu-name", "type": { "text": "string" }, "default": "'⋮'", "description": "The label of the crud action menu", "fieldName": "crudActionMenuName" } ], "mixins": [ { "name": "LifecycleMixin", "package": "@genesislcap/foundation-utils" } ], "superclass": { "name": "GenesisElement", "package": "@genesislcap/web-core" }, "tagName": "entity-management", "customElement": true } ], "exports": [ { "kind": "js", "name": "getActionNotificationTitleAndBody", "declaration": { "name": "getActionNotificationTitleAndBody", "module": "src/entities/entities.ts" } }, { "kind": "js", "name": "EntityManagement", "declaration": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "custom-element-definition", "name": "entity-management", "declaration": { "name": "EntityManagement", "module": "src/entities/entities.ts" } } ] }, { "kind": "javascript-module", "path": "src/entities/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./smartFormModal" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./entities" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./entities.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./entities.styles" } } ] }, { "kind": "javascript-module", "path": "src/entities/smartFormModal.ts", "declarations": [ { "kind": "class", "description": "A focused form dialog component that renders a single trigger button which opens a modal\ncontaining an auto-generated form.", "name": "SmartFormModal", "cssParts": [ { "description": "The trigger button that opens the modal. Style via `::part(create-button)`.", "name": "create-button" } ], "members": [ { "kind": "field", "name": "event", "type": { "text": "string" }, "description": "The Genesis event handler that processes the form submission.", "privacy": "public" }, { "kind": "method", "name": "eventChanged", "parameters": [ { "name": "_", "type": { "text": "string" } }, { "name": "next", "type": { "text": "string" } } ] }, { "kind": "field", "name": "entityLabel", "type": { "text": "string" }, "description": "Label appended to the default button text, producing \"Add {entity-label}\".", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "formUiSchema", "type": { "text": "UiSchema" }, "description": "UI schema that controls the layout and visibility of form fields.", "privacy": "public" }, { "kind": "method", "name": "formUiSchemaChanged", "parameters": [ { "name": "_", "type": { "text": "UiSchema" } }, { "name": "next", "type": { "text": "UiSchema" } } ] }, { "kind": "field", "name": "buttonLabel", "type": { "text": "string" }, "description": "Text displayed on the trigger button and as the modal title.", "privacy": "public" }, { "kind": "method", "name": "buttonLabelChanged", "parameters": [ { "name": "_", "type": { "text": "string" } }, { "name": "next", "type": { "text": "string" } } ] }, { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "'rapid'", "description": "Name of the design system prefix that will be used in renderers.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "resourceName", "type": { "text": "string" }, "description": "Name of the backend resource which contain the entities to manage", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "readEvent", "type": { "text": "string" }, "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "readEventFn", "type": { "text": "(entity) => any" }, "description": "Similar to readEvent but allows to provide function that will be executed before\nopening the form and yields data to the form", "parameters": [ { "description": "selected entity from the grid", "name": "entity" } ], "return": { "type": { "text": "" } }, "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "updateEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles updating the entity", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "deleteEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles deleting the entity", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "createEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles creating an entity", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "errorNotificationConfig", "type": { "text": "NotificationStructure['config']" }, "default": "{\n snackbar: { type: 'error' },\n }", "description": "Notification config used for submit failures. Defaults to an error snackbar but can be\noverridden while keeping title/body unchanged.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "successNotificationTitle", "type": { "text": "string" }, "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "successNotificationBody", "type": { "text": "string" }, "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "title", "type": { "text": "string" }, "description": "Title of the grid", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "createLabel", "type": { "text": "string" }, "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "rowSelection", "type": { "text": "string" }, "default": "'single'", "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableCellFlashing", "type": { "text": "boolean" }, "default": "false", "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableRowFlashing", "type": { "text": "boolean" }, "default": "false", "description": "If true, will enable row flashing for all rows for `add` transactions", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "datasourceType", "type": { "text": "DatasourceType" }, "default": "'client'", "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "persistColumnStateKey", "type": { "text": "string" }, "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "persistFilterModelKey", "type": { "text": "string" }, "description": "The key to use for persisting the filter model in local browser or KV storage.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "gridOptions", "type": { "text": "GridOptionsConfig" }, "description": "GridOptions to be passed down from application", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "statusBarConfig", "type": { "text": "GridProStatusBarConfig" }, "description": "Configuration for the grid status bar components.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "columns", "type": { "text": "GridColDef[]" }, "description": "Array which holds the column definitions.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "createFormUiSchema", "type": { "text": "UiSchema" }, "description": "Enables you to supply a schema to configure an insert form.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "updateFormUiSchema", "type": { "text": "UiSchema" }, "description": "Enables you to supply a schema to configure an update form.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "formRenderers", "type": { "text": "RendererEntry[]" }, "default": "renderers", "description": "Array with renderers used by foundation-forms", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "additionalFormRenderers", "type": { "text": "RendererEntry[]" }, "default": "[]", "description": "Additional renderer entries to append to the form renderer registry.\nUse this to supply custom UI schema renderers without replacing defaults.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "customActions", "type": { "text": "CustomAction[]" }, "default": "[]", "description": "Array of custom actions that can be added to the entity management component", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "confirmationMessage", "type": { "text": "string" }, "description": "Optional confirmation message to display before form submission.\nIf set, a confirmation dialog will be shown when the user clicks submit.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "setApprovalMessage", "type": { "text": "boolean" }, "description": "When enabled, adds an APPROVAL_MESSAGE field to the form schema.\nThis field will be sent at root level alongside DETAILS when submitting.\nCan be overridden per custom action via the action's setApprovalMessage property.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "approvalMessageLabel", "type": { "text": "string" }, "default": "'Approval Message'", "description": "Label for the approval message field in the approval dialog.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "defaultEntityValues", "type": { "text": "Record" }, "description": "The default values to populate the form with when the user is adding an entity", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "editModalVisibleChanged", "privacy": "private", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "sizeColumnsToFit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "sizeColumnsToContent", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "gridAutosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableFilterBar", "type": { "text": "boolean" }, "description": "Enables filter bar component", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "hideEdit", "type": { "text": "boolean" }, "default": "false", "description": "Hides edit button", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "hideDelete", "type": { "text": "boolean" }, "default": "false", "description": "Hides delete button", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableSearchBar", "type": { "text": "boolean" }, "default": "false", "description": "This attribute controls whether to enable the search-bar.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableAiCriteriaSearch", "type": { "text": "boolean" }, "default": "false", "description": "Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "headerCaseType", "type": { "text": "GridProCaseType" }, "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "searchBarConfig", "type": { "text": "AvailableOption[]" }, "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "gridVisible", "type": { "text": "boolean" }, "default": "true", "description": "Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid\n* @internal", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableFilters", "type": { "text": "boolean" }, "default": "false", "description": "Enables foundation-filters with flyout UI", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "filtersUiSchema", "type": { "text": "UiSchema" }, "description": "UI schema configuration for the filters component", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "showFilterPersistenceControls", "type": { "text": "boolean" }, "default": "true", "description": "Controls visibility of filter save/load UI in foundation-filters", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "filtersModalVisibleChanged", "privacy": "private", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "modalPosition", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'right'", "description": "Determines where the modal dialog will appear on screen", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "filtersModalPosition", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'left'", "description": "Determines where the filters modal will appear on screen", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "crudMenuPosition", "type": { "text": "CrudMenuPosition" }, "description": "Determines where the buttons will appear", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "crudMenuStyle", "type": { "text": "ActionsMenuStyle" }, "description": "Determines the style of the buttons", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "crudActionMenuName", "type": { "text": "string" }, "default": "'⋮'", "description": "The label of the crud action menu", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "enableCsvExport", "type": { "text": "{ buttonName?: string; fileName?: string } | null" }, "default": "null", "description": "Enabling this option will enable a download button in the top-right of the header which will export the data to a csv file when clicked.", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "setBaseCriteria", "type": { "text": "boolean" }, "privacy": "private", "default": "true", "description": "Flag which can be used to control when to cache the base criteria when the datasourceConfig changes\n(we don't want to cache in the case we've set a criteria via the search bar)", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "field", "name": "datasourceConfig", "description": "Get the configuration which is used when interacting with the resource on the backend", "privacy": "public", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "setDSConfigWithoutUpdatingBaseCriteria", "parameters": [ { "name": "config", "type": { "text": "DatasourceConfiguration" } } ], "description": "Usually when the datasource config is updated we need to cache the criteria\nso it can be combined with the searchbar, but this function allows you to set\nthe datasource config without doing that (so we don't cache the search bar\ncriteria)", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "readEntity", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "searchBarReqServer", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "SelectedOption[]" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "searchBarDataserver", "privacy": "private", "parameters": [ { "name": "options", "type": { "text": "SelectedOption[]" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "requestChanged", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "filtersCriteriaChanged", "privacy": "private", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "criteriaChanged", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "updateCombinedCriteria", "privacy": "private", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "submitFailureNotification", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "submitErrorHandler", "privacy": "private", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ], "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "showDeleteConfirmation", "privacy": "private", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "deleteColumnState", "privacy": "public", "return": { "type": { "text": "Promise" } }, "parameters": [ { "name": "resetToDefault", "default": "true", "type": { "text": "boolean" }, "description": "Whether to reset columns to their default configuration. Defaults to true." } ], "description": "Deletes the saved column state for the grid", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "kind": "method", "name": "cleanupConfirmationDialog", "privacy": "private", "description": "Ensure any confirmation dialog anchored to the modal boundary is closed/removed", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } } ], "events": [ { "description": "Fired when the form is submitted successfully. detail: `SubmitSuccessEventDetail`", "name": "submit-success", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when the form submission returns an error. detail: `SubmitFailureEventDetail`", "name": "submit-failure", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when the request is changed. detail: `Record | null`", "name": "request-changed", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when the criteria is changed. detail: `string | null`", "name": "criteria-changed", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when an entity is created", "name": "create-entity", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when an entity is edited", "name": "edit-entity", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when an entity is deleted Bubbled events from the child entity-list component", "name": "delete-entity", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when a row is clicked. detail: `Record | undefined`", "name": "rowClick", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when a row is double clicked. detail: `Record | undefined`", "name": "rowDblClick", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when a row is right clicked. detail: `Record | undefined`", "name": "contextMenu", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when a row is selected. detail: `RowSelectedEvent`", "name": "rowSelected", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "description": "Fired when grid selection changes (bubbled from entity-list). detail: `SelectionChangedEvent`", "name": "selectionChanged", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } } ], "attributes": [ { "name": "event", "type": { "text": "string" }, "description": "The Genesis event handler that processes the form submission.", "fieldName": "event" }, { "name": "entity-label", "type": { "text": "string" }, "description": "Label appended to the default button text, producing \"Add {entity-label}\".", "fieldName": "entityLabel" }, { "name": "button-label", "type": { "text": "string" }, "description": "Text displayed on the trigger button and as the modal title.", "fieldName": "buttonLabel" }, { "name": "design-system-prefix", "type": { "text": "string" }, "default": "'rapid'", "description": "Name of the design system prefix that will be used in renderers.", "fieldName": "prefix", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "resourceName", "type": { "text": "string" }, "description": "Name of the backend resource which contain the entities to manage", "fieldName": "resourceName", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "readEvent", "type": { "text": "string" }, "description": "Name of the request on the Genesis server which fetches data for the form, example usage could\ninclude fetching additional data that is not available in the grid but required for the selected entity", "fieldName": "readEvent", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "updateEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles updating the entity", "fieldName": "updateEvent", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "deleteEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles deleting the entity", "fieldName": "deleteEvent", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "createEvent", "type": { "text": "string" }, "description": "Name of the event handler on the Genesis server which handles creating an entity", "fieldName": "createEvent", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "success-notification-title", "type": { "text": "string" }, "description": "Overrides the success notification title shown after a successful form submission.\nWhen not set, the default \"{label} Added / Updated / Deleted\" title is used.", "fieldName": "successNotificationTitle", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "success-notification-body", "type": { "text": "string" }, "description": "Overrides the success notification body shown after a successful form submission.\nWhen not set, the default \"The {label} was successfully added/updated/deleted\" body is used.", "fieldName": "successNotificationBody", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "title", "type": { "text": "string" }, "description": "Title of the grid", "fieldName": "title", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "entityLabel", "type": { "text": "string" }, "description": "Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications", "fieldName": "entityLabel", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "create-label", "type": { "text": "string" }, "description": "Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.", "fieldName": "createLabel", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "row-selection", "type": { "text": "string" }, "default": "'single'", "description": "This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.", "fieldName": "rowSelection", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-cell-flashing", "type": { "text": "boolean" }, "default": "false", "description": "If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef", "fieldName": "enableCellFlashing", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-row-flashing", "type": { "text": "boolean" }, "default": "false", "description": "If true, will enable row flashing for all rows for `add` transactions", "fieldName": "enableRowFlashing", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "datasource-type", "type": { "text": "DatasourceType" }, "default": "'client'", "description": "If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component.\nBy default `grid-pro-client-side-datasource` will be used.", "fieldName": "datasourceType", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "persist-column-state-key", "type": { "text": "string" }, "description": "This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.", "fieldName": "persistColumnStateKey", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "persist-filter-model-key", "type": { "text": "string" }, "description": "The key to use for persisting the filter model in local browser or KV storage.", "fieldName": "persistFilterModelKey", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "confirmation-message", "type": { "text": "string" }, "description": "Optional confirmation message to display before form submission.\nIf set, a confirmation dialog will be shown when the user clicks submit.", "fieldName": "confirmationMessage", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "set-approval-message", "type": { "text": "boolean" }, "description": "When enabled, adds an APPROVAL_MESSAGE field to the form schema.\nThis field will be sent at root level alongside DETAILS when submitting.\nCan be overridden per custom action via the action's setApprovalMessage property.", "fieldName": "setApprovalMessage", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "approval-message-label", "type": { "text": "string" }, "default": "'Approval Message'", "description": "Label for the approval message field in the approval dialog.", "fieldName": "approvalMessageLabel", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "size-columns-to-fit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "fieldName": "sizeColumnsToFit", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "size-columns-to-content", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "fieldName": "sizeColumnsToContent", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "grid-autosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "fieldName": "gridAutosizing", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-filter-bar", "type": { "text": "boolean" }, "description": "Enables filter bar component", "fieldName": "enableFilterBar", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "hide-edit", "type": { "text": "boolean" }, "default": "false", "description": "Hides edit button", "fieldName": "hideEdit", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "hide-delete", "type": { "text": "boolean" }, "default": "false", "description": "Hides delete button", "fieldName": "hideDelete", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-search-bar", "type": { "text": "boolean" }, "default": "false", "description": "This attribute controls whether to enable the search-bar.", "fieldName": "enableSearchBar", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-ai-criteria-search", "type": { "text": "boolean" }, "default": "false", "description": "Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.", "fieldName": "enableAiCriteriaSearch", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "header-case-type", "type": { "text": "GridProCaseType" }, "description": "The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.", "fieldName": "headerCaseType", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "enable-filters", "type": { "text": "boolean" }, "default": "false", "description": "Enables foundation-filters with flyout UI", "fieldName": "enableFilters", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "show-filter-persistence-controls", "type": { "text": "boolean" }, "default": "true", "description": "Controls visibility of filter save/load UI in foundation-filters", "fieldName": "showFilterPersistenceControls", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "modal-position", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'right'", "description": "Determines where the modal dialog will appear on screen", "fieldName": "modalPosition", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "filters-modal-position", "type": { "text": "'centre' | 'left' | 'right'" }, "default": "'left'", "description": "Determines where the filters modal will appear on screen", "fieldName": "filtersModalPosition", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "crud-menu-position", "type": { "text": "CrudMenuPosition" }, "description": "Determines where the buttons will appear", "fieldName": "crudMenuPosition", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "crud-menu-style", "type": { "text": "ActionsMenuStyle" }, "description": "Determines the style of the buttons", "fieldName": "crudMenuStyle", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } }, { "name": "crud-action-menu-name", "type": { "text": "string" }, "default": "'⋮'", "description": "The label of the crud action menu", "fieldName": "crudActionMenuName", "inheritedFrom": { "name": "EntityManagement", "module": "src/entities/entities.ts" } } ], "superclass": { "name": "EntityManagement", "module": "/src/entities/entities" }, "tagName": "smart-form-modal", "customElement": true } ], "exports": [ { "kind": "js", "name": "SmartFormModal", "declaration": { "name": "SmartFormModal", "module": "src/entities/smartFormModal.ts" } }, { "kind": "custom-element-definition", "name": "smart-form-modal", "declaration": { "name": "SmartFormModal", "module": "src/entities/smartFormModal.ts" } } ] }, { "kind": "javascript-module", "path": "src/layouts/default.ts", "declarations": [ { "kind": "variable", "name": "loginLayout", "default": "new GenesisElementLayout(\n html`\n
\n
\n \n
\n
\n `,\n baseLayoutCss,\n)" }, { "kind": "variable", "name": "defaultLayout", "default": "new GenesisElementLayout(\n html`\n
\n
\n \n
\n
\n `,\n css`\n ${baseLayoutCss}\n `,\n)" } ], "exports": [ { "kind": "js", "name": "loginLayout", "declaration": { "name": "loginLayout", "module": "src/layouts/default.ts" } }, { "kind": "js", "name": "defaultLayout", "declaration": { "name": "defaultLayout", "module": "src/layouts/default.ts" } } ] }, { "kind": "javascript-module", "path": "src/layouts/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./default" } } ] }, { "kind": "javascript-module", "path": "src/list/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./list" } } ] }, { "kind": "javascript-module", "path": "src/list/list.styles.ts", "declarations": [ { "kind": "variable", "name": "listStyles", "default": "css`\n :host {\n contain: content;\n }\n\n :host,\n fast-router {\n display: flex;\n flex-direction: column;\n width: 100%;\n height: 100%;\n }\n\n .container {\n display: flex;\n flex-direction: column;\n height: inherit;\n width: 100%;\n }\n`" } ], "exports": [ { "kind": "js", "name": "listStyles", "declaration": { "name": "listStyles", "module": "src/list/list.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/list/list.template.ts", "declarations": [ { "kind": "function", "name": "getPrefixedList", "parameters": [ { "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "getPrefixedList", "declaration": { "name": "getPrefixedList", "module": "src/list/list.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/list/list.ts", "declarations": [ { "kind": "class", "description": "Entity list grid with CRUD and selection events.", "name": "List", "members": [ { "kind": "field", "name": "prefix", "type": { "text": "string" }, "default": "'zero'", "description": "Name of the design system prefix that will be used in renderers.", "privacy": "public" }, { "kind": "field", "name": "resourceName", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "title", "type": { "text": "string" }, "default": "''" }, { "kind": "field", "name": "persistColumnStateKey", "type": { "text": "string" } }, { "kind": "field", "name": "persistFilterModelKey", "type": { "text": "string" } }, { "kind": "field", "name": "sizeColumnsToFit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "privacy": "public" }, { "kind": "field", "name": "sizeColumnsToContent", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "privacy": "public" }, { "kind": "field", "name": "gridAutosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "privacy": "public" }, { "kind": "field", "name": "rowSelection", "type": { "text": "string" } }, { "kind": "field", "name": "enableFilterBar", "type": { "text": "boolean" } }, { "kind": "field", "name": "asyncAdd", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "asyncRemove", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "asyncUpdate", "type": { "text": "boolean" }, "default": "true" }, { "kind": "field", "name": "enableCellFlashing", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "enableRowFlashing", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "hideEdit", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "hideDelete", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "datasourceType", "type": { "text": "DatasourceType" }, "default": "'client'" }, { "kind": "field", "name": "headerCaseType", "type": { "text": "GridProCaseType" } }, { "kind": "field", "name": "grid", "type": { "text": "ZeroGridPro" }, "privacy": "public" }, { "kind": "field", "name": "datasource", "type": { "text": "GridProGenesisDatasource" }, "privacy": "public" }, { "kind": "field", "name": "gridOptions", "type": { "text": "GridOptionsConfig" } }, { "kind": "field", "name": "columns", "type": { "text": "GridColDef[]" } }, { "kind": "field", "name": "datasourceConfig", "type": { "text": "DatasourceConfiguration" } }, { "kind": "field", "name": "actionButtonsConfig", "type": { "text": "array" }, "default": "[]" }, { "kind": "field", "name": "createEvent", "type": { "text": "string" } }, { "kind": "field", "name": "updateEvent", "type": { "text": "string" } }, { "kind": "field", "name": "deleteEvent", "type": { "text": "string" } }, { "kind": "field", "name": "statusBarConfig", "type": { "text": "GridProStatusBarConfig" } }, { "kind": "field", "name": "customActions", "type": { "text": "CustomAction[]" }, "default": "[]" }, { "kind": "field", "name": "connect", "type": { "text": "Connect" }, "privacy": "protected" }, { "kind": "field", "name": "isServerSideDatasource", "type": { "text": "boolean" }, "readonly": true }, { "kind": "method", "name": "handleCellEditRequest", "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "actionColumnIcon", "privacy": "private", "parameters": [ { "name": "iconName", "type": { "text": "string" } }, { "name": "variant", "default": "'solid'", "type": { "text": "'solid' | 'regular'" } } ], "description": "Shared markup for CRUD / custom action column icons (grid cell renderers)." }, { "kind": "method", "name": "populateActionButtonsConfig", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Builds column defs for CRUD / custom actions in the grid (pinned action column)." }, { "kind": "field", "name": "criteria", "readonly": true }, { "kind": "field", "name": "fields", "readonly": true }, { "kind": "field", "name": "isSnapshot", "readonly": true }, { "kind": "field", "name": "maxRows", "readonly": true }, { "kind": "field", "name": "maxView", "readonly": true }, { "kind": "field", "name": "movingView", "readonly": true }, { "kind": "field", "name": "orderBy", "readonly": true }, { "kind": "field", "name": "pollingInterval", "readonly": true }, { "kind": "field", "name": "pollTriggerEvents", "readonly": true }, { "kind": "field", "name": "request", "readonly": true }, { "kind": "field", "name": "reverse", "readonly": true }, { "kind": "field", "name": "viewNumber", "readonly": true }, { "kind": "field", "name": "disablePolling", "readonly": true }, { "kind": "field", "name": "requestAutoSetup", "readonly": true }, { "kind": "method", "name": "handleRowClicked", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleRowDblClicked", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleRowContextMenu", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleFilterChanged", "privacy": "private", "parameters": [ { "name": "e" } ] }, { "kind": "method", "name": "handleFilterCleared", "privacy": "private", "parameters": [ { "name": "e" } ] }, { "kind": "method", "name": "handleRowSelected", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "handleSelectionChanged", "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "field", "name": "edit", "privacy": "private" }, { "kind": "method", "name": "delete", "parameters": [ { "name": "e" } ] }, { "kind": "field", "name": "handleCustomAction", "privacy": "private" } ], "events": [ { "description": "Fired when an inline update submit fails. detail: `SubmitFailureEventDetail`", "name": "submit-failure" }, { "description": "Fired when an inline update succeeds. detail: `SubmitSuccessEventDetail`", "name": "submit-success" }, { "description": "Fired when a row is clicked. detail: `Record | undefined`", "name": "rowClick" }, { "description": "Fired when a row is double-clicked. detail: `Record | undefined`", "name": "rowDblClick" }, { "description": "Fired when a row context menu is opened. detail: `Record | undefined`", "name": "contextMenu" }, { "description": "Fired when row selection changes (single). detail: `RowSelectedEvent`", "name": "rowSelected" }, { "description": "Fired when grid selection changes. detail: `SelectionChangedEvent`", "name": "selectionChanged" }, { "description": "Fired when edit is requested", "name": "edit-entity" }, { "description": "Fired when delete is requested", "name": "delete-entity" }, { "description": "Fired when a custom grid action runs. detail: `CustomActionEventDetail`", "name": "custom-action" } ], "attributes": [ { "name": "design-system-prefix", "type": { "text": "string" }, "default": "'zero'", "description": "Name of the design system prefix that will be used in renderers.", "fieldName": "prefix" }, { "name": "resourceName", "type": { "text": "string" }, "default": "''", "fieldName": "resourceName" }, { "name": "title", "type": { "text": "string" }, "default": "''", "fieldName": "title" }, { "name": "persist-column-state-key", "type": { "text": "string" }, "fieldName": "persistColumnStateKey" }, { "name": "persist-filter-model-key", "type": { "text": "string" }, "fieldName": "persistFilterModelKey" }, { "name": "size-columns-to-fit", "type": { "text": "boolean" }, "description": "Resizes columns to take available space", "fieldName": "sizeColumnsToFit" }, { "name": "size-columns-to-content", "type": { "text": "boolean" }, "description": "Auto-sizes a column based on its contents", "fieldName": "sizeColumnsToContent" }, { "name": "grid-autosizing", "type": { "text": "boolean" }, "description": "Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.", "fieldName": "gridAutosizing" }, { "name": "row-selection", "type": { "text": "string" }, "fieldName": "rowSelection" }, { "name": "enable-filter-bar", "type": { "text": "boolean" }, "fieldName": "enableFilterBar" }, { "name": "async-add", "type": { "text": "boolean" }, "default": "false", "fieldName": "asyncAdd" }, { "name": "async-remove", "type": { "text": "boolean" }, "default": "false", "fieldName": "asyncRemove" }, { "name": "async-update", "type": { "text": "boolean" }, "default": "true", "fieldName": "asyncUpdate" }, { "name": "enable-cell-flashing", "type": { "text": "boolean" }, "default": "false", "fieldName": "enableCellFlashing" }, { "name": "enable-row-flashing", "type": { "text": "boolean" }, "default": "false", "fieldName": "enableRowFlashing" }, { "name": "hide-edit", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideEdit" }, { "name": "hide-delete", "type": { "text": "boolean" }, "default": "false", "fieldName": "hideDelete" }, { "name": "datasource-type", "type": { "text": "DatasourceType" }, "default": "'client'", "fieldName": "datasourceType" }, { "name": "header-case-type", "type": { "text": "GridProCaseType" }, "fieldName": "headerCaseType" } ], "mixins": [ { "name": "LifecycleMixin", "package": "@genesislcap/foundation-utils" } ], "superclass": { "name": "GenesisElement", "package": "@genesislcap/web-core" }, "tagName": "entity-list", "customElement": true } ], "exports": [ { "kind": "js", "name": "List", "declaration": { "name": "List", "module": "src/list/list.ts" } }, { "kind": "custom-element-definition", "name": "entity-list", "declaration": { "name": "List", "module": "src/list/list.ts" } } ] }, { "kind": "javascript-module", "path": "src/main/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./main.template" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./main" } } ] }, { "kind": "javascript-module", "path": "src/main/main.styles.ts", "declarations": [ { "kind": "variable", "name": "MainStyles", "default": "css`\n ${mixinRobotoFont()}\n :host {\n contain: content;\n }\n\n :host,\n zero-design-system-provider,\n .dynamic-template,\n foundation-router {\n display: flex;\n width: 100%;\n height: 100%;\n }\n\n fast-progress {\n --accent-foreground-rest: #654df9;\n\n height: calc(var(--design-unit) * 1px);\n margin: 0;\n width: 100%;\n }\n`" } ], "exports": [ { "kind": "js", "name": "MainStyles", "declaration": { "name": "MainStyles", "module": "src/main/main.styles.ts" } } ] }, { "kind": "javascript-module", "path": "src/main/main.template.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/main/main.ts", "declarations": [ { "kind": "class", "description": "", "name": "MainApplication", "members": [ { "kind": "field", "name": "config", "type": { "text": "MainRouterConfig" } }, { "kind": "field", "name": "connect", "type": { "text": "Connect" } }, { "kind": "field", "name": "session", "type": { "text": "Session" } }, { "kind": "field", "name": "container", "type": { "text": "Container" } }, { "kind": "field", "name": "provider", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "ready", "type": { "text": "boolean" }, "default": "false" }, { "kind": "method", "name": "onLuminanceToggle" }, { "kind": "method", "name": "loadRemotes" }, { "kind": "method", "name": "selectTemplate" }, { "kind": "method", "name": "registerDIDependencies", "privacy": "private" } ], "superclass": { "name": "GenesisElement", "package": "@genesislcap/web-core" } } ], "exports": [ { "kind": "js", "name": "MainApplication", "declaration": { "name": "MainApplication", "module": "src/main/main.ts" } }, { "kind": "custom-element-definition", "declaration": { "name": "MainApplication", "module": "src/main/main.ts" } } ] }, { "kind": "javascript-module", "path": "src/routes/config.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/routes/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./config" } } ] }, { "kind": "javascript-module", "path": "src/utils/custom-actions-utils.ts", "declarations": [ { "kind": "function", "name": "mapDefaultValues", "return": { "type": { "text": "" } }, "parameters": [ { "name": "defaultValues", "type": { "text": "Record" }, "description": "Object containing default values with potential record mappings" }, { "name": "rowData", "type": { "text": "any" }, "description": "The row data containing values to map from" } ], "description": "Map default values for custom actions\n\nTransform default values object by replacing values with special type 'record'\nwith corresponding values from the row data" } ], "exports": [ { "kind": "js", "name": "mapDefaultValues", "declaration": { "name": "mapDefaultValues", "module": "src/utils/custom-actions-utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/formatting.ts", "declarations": [ { "kind": "function", "name": "getErrorFormat", "parameters": [ { "name": "err" } ], "description": "Format the error as a string with a different format depending on whether\n`err` has a `FIELD` property or not", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "getErrorFormat", "declaration": { "name": "getErrorFormat", "module": "src/utils/formatting.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/index.ts", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./custom-actions-utils" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./formatting" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./logger" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./renderer" } }, { "kind": "js", "name": "UiSchema", "declaration": { "name": "UiSchema", "package": "@genesislcap/foundation-forms" } }, { "kind": "js", "name": "UiSchemaElement", "declaration": { "name": "UiSchemaElement", "package": "@genesislcap/foundation-forms" } }, { "kind": "js", "name": "UiSchemaOptions", "declaration": { "name": "UiSchemaOptions", "package": "@genesislcap/foundation-forms" } }, { "kind": "js", "name": "UiSchemaElementType", "declaration": { "name": "UiSchemaElementType", "package": "@genesislcap/foundation-forms" } } ] }, { "kind": "javascript-module", "path": "src/utils/logger.ts", "declarations": [ { "kind": "variable", "name": "logger", "privacy": "public" } ], "exports": [ { "kind": "js", "name": "logger", "declaration": { "name": "logger", "module": "src/utils/logger.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/renderer.ts", "declarations": [ { "kind": "function", "name": "buttonCellRenderer", "return": { "type": { "text": "ColDef" } }, "parameters": [ { "name": "title" }, { "name": "clickHandler" }, { "name": "contentTemplate" }, { "name": "tooltip", "default": "''" } ], "privacy": "public" } ], "exports": [ { "kind": "js", "name": "buttonCellRenderer", "declaration": { "name": "buttonCellRenderer", "module": "src/utils/renderer.ts" } } ] }, { "kind": "javascript-module", "path": "src/utils/search-bar-utils.ts", "declarations": [ { "kind": "function", "name": "getSearchBarColumnsConfig", "parameters": [ { "name": "columns", "type": { "text": "GridColDef[]" } }, { "name": "meta", "type": { "text": "Metadata" } }, { "name": "changeCase", "type": { "text": "(input: string) => string" } } ] }, { "kind": "function", "name": "getSearchBarMetaConfig", "parameters": [ { "name": "meta", "type": { "text": "Metadata" } }, { "name": "changeCase", "type": { "text": "(input: string) => string" } } ] } ], "exports": [ { "kind": "js", "name": "getSearchBarColumnsConfig", "declaration": { "name": "getSearchBarColumnsConfig", "module": "src/utils/search-bar-utils.ts" } }, { "kind": "js", "name": "getSearchBarMetaConfig", "declaration": { "name": "getSearchBarMetaConfig", "module": "src/utils/search-bar-utils.ts" } } ] }, { "kind": "javascript-module", "path": "src/routes/demo/entity-management.template.ts", "declarations": [ { "kind": "variable", "name": "EntityManagementDemoTemplate", "type": { "text": "ViewTemplate" }, "default": "html`\n \n Entity Management\n Counterparty\n \n Counterparty with Confirmation\n \n \n \n \n \n \n \n \n \n \n \n \n`" } ], "exports": [ { "kind": "js", "name": "EntityManagementDemoTemplate", "declaration": { "name": "EntityManagementDemoTemplate", "module": "src/routes/demo/entity-management.template.ts" } } ] }, { "kind": "javascript-module", "path": "src/routes/demo/entity-management.ts", "declarations": [ { "kind": "class", "description": "", "name": "EntityManagementDemo", "superclass": { "name": "GenesisElement", "package": "@genesislcap/web-core" }, "tagName": "entity-management-demo", "customElement": true } ], "exports": [ { "kind": "js", "name": "EntityManagementDemo", "declaration": { "name": "EntityManagementDemo", "module": "src/routes/demo/entity-management.ts" } }, { "kind": "custom-element-definition", "name": "entity-management-demo", "declaration": { "name": "EntityManagementDemo", "module": "src/routes/demo/entity-management.ts" } } ] } ] }