Open Source Web Application Framework for ASP.NET Core
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

330 lines
14 KiB

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "page-descriptor.schema.json",
"title": "PageDescriptor",
"description": "Describes a runtime UI page. Pages create menu items and choose how an entity or dashboard is rendered.",
"markdownDescription": "AI guidance: `name` is the stable route/menu key and should be URL-safe kebab-case (for example `customers` or `event-calendar`). `title` is user-facing. For entity pages, set `entityName` to an existing entity. Configure list/gallery/card visibility with `columns`, filtering with `filters`, server-enforced scoping with `backendFilter`, related-record access with `relationships`, and create/edit UI with form names. Use `enumPresentations` to override enum display for this page only. For `dashboard` pages, provide `dashboard` and omit entity-only fields unless intentionally supported by the runtime. Do not put page-only settings on entity properties.",
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "Optional schema reference used when this descriptor is stored as a model descriptor file."
},
"name": {
"type": "string",
"description": "Stable URL-safe page identifier. Prefer kebab-case, for example 'customers', 'event-calendar', or 'sales-dashboard'. This becomes part of the runtime route and is referenced by saveSuccessPageName and relationships.",
"minLength": 1
},
"app": {
"type": "string",
"description": "Name of the low-code app that owns this page. Omit for the default app. Must match an apps[].name.",
"minLength": 1,
"pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
},
"title": {
"type": "string",
"description": "Display title for the menu item and page header.",
"minLength": 1
},
"icon": {
"type": "string",
"description": "FontAwesome icon class for the menu item, for example 'fa-solid fa-users'."
},
"showInMenu": {
"type": "boolean",
"description": "Whether the page gets a menu item. Set false for pages that are only reached through relationships, saveSuccessPageName, or direct links.",
"default": true
},
"type": {
"$ref": "page-type.schema.json"
},
"entityName": {
"type": "string",
"description": "Full name of the root entity this page displays. Required for dataGrid, kanban, calendar, gallery, and form pages. Usually omitted for dashboard pages.",
"minLength": 1
},
"groupByProperty": {
"type": "string",
"description": "Property name to group entities by. Required for kanban pages. Must reference a property on entityName, preferably an enum/status property with a small fixed set of values.",
"minLength": 1
},
"calendarStartProperty": {
"type": "string",
"description": "Date or DateTime property used as the start date for calendar pages. Required for calendar pages.",
"minLength": 1
},
"calendarEndProperty": {
"type": "string",
"description": "Optional Date or DateTime property used as the end date for calendar pages. Use when events can span a date range.",
"minLength": 1
},
"calendarTimeProperty": {
"type": "string",
"description": "Optional Time property used as the start time for calendar pages when the start date is date-only or time is stored separately.",
"minLength": 1
},
"calendarDurationProperty": {
"type": "string",
"description": "Optional numeric property used as duration in minutes for calendar pages. Use this instead of calendarEndProperty when records store duration.",
"minLength": 1
},
"galleryImageProperty": {
"type": "string",
"description": "Optional Image property used as the cover image for gallery pages. The property should have entity property type image; an image collection property is supported with galleryImagePresentation.",
"minLength": 1
},
"galleryImagePresentation": {
"type": ["string", "null"],
"description": "How gallery cards render galleryImageProperty. 'coverLightbox' shows a cover image that opens a lightbox; 'inlineSlider' shows an inline slider (useful for image collections). Omit for the default cover presentation.",
"enum": ["coverLightbox", "CoverLightbox", "inlineSlider", "InlineSlider", null]
},
"defaultSortProperty": {
"type": "string",
"description": "Optional property used as the default sorting field when the client does not send explicit sorting. Must reference a property on entityName.",
"minLength": 1
},
"defaultSortDescending": {
"type": "boolean",
"description": "Whether the default sort property is sorted descending.",
"default": false
},
"defaultFileExportMode": {
"type": ["integer", "null"],
"enum": [0, 1, 2, 3, null],
"description": "Default spreadsheet output for file/image columns. 0 exports file names, 1 exports metadata columns, 2 exports temporary download-link columns, and 3 exports file names with download links."
},
"allowFileBundleExport": {
"type": "boolean",
"description": "Whether ZIP file bundle export is available for exportable file/image columns on this page.",
"default": true
},
"importEnabled": {
"type": "boolean",
"description": "Whether the React runtime exposes guided Excel/CSV import for this page.",
"default": true
},
"columns": {
"type": "array",
"description": "Page-owned column/card field configuration. Use for dataGrid, kanban card fields, calendar event fields, and gallery card fields. Each propertyName must reference a property on entityName or a dot-separated related path such as 'CustomerId.Name'.",
"items": {
"$ref": "page-column-descriptor.schema.json"
}
},
"filters": {
"type": "array",
"description": "Page-owned filter configuration for filterable page types. Each propertyName must reference a property on entityName or a related path. Use this instead of legacy property-level UI filter settings.",
"items": {
"$ref": "page-filter-descriptor.schema.json"
}
},
"enumPresentations": {
"type": "array",
"description": "Page-level overrides for enum value display (label, presentation, color, icon). Each propertyName may appear once.",
"items": {
"$ref": "page-enum-presentation-descriptor.schema.json"
}
},
"relationships": {
"type": "array",
"description": "Reverse relationships shown from this page: records of other entities whose foreign key points at the page entity. Each id must be unique within the page.",
"items": {
"$ref": "page-relationship-descriptor.schema.json"
}
},
"backendFilter": {
"$ref": "page-backend-filter-expression.schema.json",
"description": "Server-enforced filter expression that is always applied to this page's queries and cannot be removed by the client."
},
"order": {
"type": "integer",
"description": "Menu sort order (lower values appear first)",
"default": 0
},
"formName": {
"type": "string",
"description": "Name of the form to render. Required when type is 'form'. Must match a form descriptor whose entityName matches this page entityName.",
"minLength": 1
},
"createFormName": {
"type": "string",
"description": "Name of the form to use when creating records from dataGrid, kanban, calendar, or gallery pages. Must match a form descriptor for the same entity."
},
"editFormName": {
"type": "string",
"description": "Name of the form to use when editing records from dataGrid, kanban, calendar, or gallery pages. Must match a form descriptor for the same entity."
},
"createFormDisplay": {
"type": "string",
"enum": ["modal", "Modal", "page", "Page"],
"description": "How to display the create form. Use 'modal' for quick CRUD; use 'page' for longer forms or when deep links are desired.",
"default": "modal"
},
"editFormDisplay": {
"type": "string",
"enum": ["modal", "Modal", "page", "Page"],
"description": "How to display the edit form. Use 'modal' for quick CRUD; use 'page' for longer forms or when deep links are desired.",
"default": "modal"
},
"saveSuccessNavigation": {
"type": "string",
"enum": ["stay", "page", "url"],
"description": "Navigation behavior after a standalone form page saves successfully. 'stay' keeps the user on the form page; 'page' navigates to saveSuccessPageName; 'url' navigates to saveSuccessUrl.",
"default": "stay"
},
"saveSuccessPageName": {
"type": "string",
"description": "Existing page name to open after a form page saves successfully when saveSuccessNavigation is 'page'.",
"minLength": 1
},
"saveSuccessUrl": {
"type": "string",
"description": "URL or application path to open after a form page saves successfully when saveSuccessNavigation is 'url'.",
"minLength": 1
},
"dashboard": {
"$ref": "dashboard-descriptor.schema.json",
"description": "Dashboard layout and visualizations. Required only when type is dashboard."
},
"group": {
"type": "string",
"description": "Name of the page group this page belongs to. Must match pageGroups[].name. Omit for root-level pages.",
"minLength": 1
},
"permissionConfig": {
"$ref": "page-permission-config.schema.json",
"description": "Optional page operation permission overrides. Omit operations to use generated defaults."
},
"interceptors": {
"type": "array",
"description": "Page-scoped Create/Update/Delete command interceptors that run for commands issued through this page, ordered relative to entity interceptors by entityExecutionOrder.",
"items": {
"$ref": "page-command-interceptor-descriptor.schema.json"
}
},
"extendsLowerLayer": {
"type": "boolean",
"description": "When true, this descriptor overrides selected fields of a page with the same name defined in a lower model layer; title, entityName, and type-specific required fields become optional.",
"default": false
},
"metadata": {
"$ref": "descriptor-metadata.schema.json"
}
},
"required": ["name"],
"if": {
"properties": { "extendsLowerLayer": { "const": true } },
"required": ["extendsLowerLayer"]
},
"then": {},
"else": {
"required": ["title", "type"],
"allOf": [
{
"if": {
"properties": { "type": { "enum": ["dataGrid", "DataGrid"] } }
},
"then": {
"required": ["entityName"]
}
},
{
"if": {
"properties": { "type": { "enum": ["kanban", "Kanban"] } }
},
"then": {
"required": ["entityName", "groupByProperty"]
}
},
{
"if": {
"properties": { "type": { "enum": ["calendar", "Calendar"] } }
},
"then": {
"required": ["entityName", "calendarStartProperty"]
}
},
{
"if": {
"properties": { "type": { "enum": ["gallery", "Gallery"] } }
},
"then": {
"required": ["entityName"]
}
},
{
"if": {
"properties": { "type": { "enum": ["form", "Form"] } }
},
"then": {
"required": ["entityName", "formName"]
}
},
{
"if": {
"properties": { "type": { "enum": ["dashboard", "Dashboard"] } }
},
"then": {
"required": ["dashboard"]
}
}
]
},
"additionalProperties": false,
"examples": [
{
"name": "events",
"title": "Events",
"type": "dataGrid",
"entityName": "Acme.Events.Event",
"columns": [
{ "propertyName": "Title", "order": 0 },
{ "propertyName": "Status", "order": 1 },
{ "propertyName": "IsPublished", "order": 2, "booleanPresentation": "badge", "booleanValues": { "true": { "displayName": "Published", "color": "#16A34A" }, "false": { "displayName": "Draft", "color": "#6B7280" } } }
],
"filters": [
{ "propertyName": "Title", "control": "text", "defaultOperator": "contains" }
],
"enumPresentations": [
{ "propertyName": "Status", "values": [{ "value": 2, "displayName": "Done", "presentation": "badge", "color": "#16A34A" }] }
],
"relationships": [
{ "id": "event-sessions", "sourceEntityName": "Acme.Events.Session", "sourcePropertyName": "EventId", "access": "edit", "relatedPageMode": "generated", "createFormMode": "generated", "editFormMode": "generated" }
],
"backendFilter": { "propertyName": "OrganizerId", "operator": "equal", "valueProvider": "CurrentUserId" },
"createFormName": "event-form",
"editFormName": "event-form"
},
{
"name": "event-calendar",
"title": "Event Calendar",
"type": "calendar",
"entityName": "Acme.Events.Event",
"calendarStartProperty": "StartDate",
"calendarEndProperty": "EndDate",
"showInMenu": false
},
{
"name": "event-dashboard",
"title": "Event Dashboard",
"type": "dashboard",
"dashboard": {
"visualizations": [
{
"name": "events-by-status",
"type": "chart",
"title": "Events by Status",
"row": 0,
"order": 0,
"width": 2,
"entityName": "Acme.Events.Event",
"chart": {
"chartType": "bar",
"xAxis": { "property": "Status" },
"yAxis": [{ "aggregation": "count", "label": "Events" }]
}
}
]
}
}
]
}