pgkiln 0.41.0 → 0.42.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/db/migrations/097_generated_app_quality.sql +911 -0
- package/db/migrations/098_app_activity.sql +37 -0
- package/docs/apex-feature-parity.md +5 -5
- package/docs/guide/03-builder.md +66 -18
- package/docs/guide/09-reference.md +6 -2
- package/docs/guide/11-from-apex.md +1 -1
- package/docs/guide/12-development.md +1 -1
- package/docs/guide/14-globalization.md +7 -3
- package/docs/guide/17-mobile.md +1 -1
- package/package.json +1 -1
- package/public/app.css +175 -33
- package/public/app.js +80 -0
- package/public/builder.css +30 -2
- package/public/builder.js +31 -0
- package/src/builder/appfromfile.ts +5 -4
- package/src/builder/appsheets.ts +23 -9
- package/src/builder/appwizard.ts +215 -70
- package/src/builder/blueprints.ts +2 -1
- package/src/builder/components.ts +1 -1
- package/src/builder/home.ts +2 -32
- package/src/builder/newapp.ts +182 -5
- package/src/builder/routes.ts +4 -28
- package/src/i18n/ar.ts +1 -0
- package/src/i18n/cs.ts +1 -0
- package/src/i18n/da.ts +1 -0
- package/src/i18n/de.ts +1 -0
- package/src/i18n/el.ts +1 -0
- package/src/i18n/es.ts +1 -0
- package/src/i18n/fi.ts +1 -0
- package/src/i18n/fr.ts +1 -0
- package/src/i18n/he.ts +1 -0
- package/src/i18n/it.ts +1 -0
- package/src/i18n/ja.ts +1 -0
- package/src/i18n/ko.ts +1 -0
- package/src/i18n/nb.ts +1 -0
- package/src/i18n/pl.ts +1 -0
- package/src/i18n/pt.ts +1 -0
- package/src/i18n/ru.ts +1 -0
- package/src/i18n/sv.ts +1 -0
- package/src/i18n/tr.ts +1 -0
- package/src/i18n/uk.ts +1 -0
- package/src/i18n/zh.ts +1 -0
- package/src/i18n.ts +2 -0
- package/src/icons.ts +2 -1
- package/src/layout.ts +2 -2
- package/src/runtime/charts.ts +8 -3
- package/src/runtime/devbar.ts +35 -14
- package/src/runtime/engine.ts +7 -4
- package/src/runtime/locale.ts +2 -2
- package/src/runtime/regions.ts +25 -2
- package/src/runtime/render.ts +18 -4
- package/src/runtime/report.ts +15 -9
- package/src/runtime/styles.ts +5 -2
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
-- =====================================================================
|
|
2
|
+
-- 098: activity reporting for an application's administrators (sprint 73;
|
|
3
|
+
-- APEX: the Activity Reporting feature of the Create Application wizard)
|
|
4
|
+
--
|
|
5
|
+
-- meta.app_activity(days): the page views, sign-ins and errors of the
|
|
6
|
+
-- current application (meta.app_id()) in the last days (1 to 366), newest
|
|
7
|
+
-- first, at most 10,000 rows. Only for a signed-in user with the admin role
|
|
8
|
+
-- whose session belongs to that application; anyone else gets an error.
|
|
9
|
+
-- The client's IP address and the error details are left out.
|
|
10
|
+
--
|
|
11
|
+
-- The wizard's Activity page (page 9010, authorization ADMIN) reads it:
|
|
12
|
+
-- select * from meta.app_activity(30)
|
|
13
|
+
-- =====================================================================
|
|
14
|
+
create function meta.app_activity(p_days int default 30)
|
|
15
|
+
returns table (at timestamptz, username text, event text, page_no int, elapsed_ms int)
|
|
16
|
+
language plpgsql stable security definer set search_path = meta, pg_catalog as $$
|
|
17
|
+
declare
|
|
18
|
+
v_app int := meta.app_id();
|
|
19
|
+
v_session uuid := nullif(current_setting('pgkiln.session_id', true), '')::uuid;
|
|
20
|
+
begin
|
|
21
|
+
if v_app is null or v_session is null
|
|
22
|
+
or not exists (select 1 from meta.session s where s.id = v_session and s.app_id = v_app)
|
|
23
|
+
or not meta.has_role('admin') then
|
|
24
|
+
raise exception 'the activity of this application is for its administrators' using errcode = '42501';
|
|
25
|
+
end if;
|
|
26
|
+
return query
|
|
27
|
+
select l.at, l.username, l.event, l.page_no, l.elapsed_ms
|
|
28
|
+
from meta.activity_log l
|
|
29
|
+
where l.app_id = v_app
|
|
30
|
+
and l.at > now() - make_interval(days => least(greatest(coalesce(p_days, 30), 1), 366))
|
|
31
|
+
order by l.at desc
|
|
32
|
+
limit 10000;
|
|
33
|
+
end
|
|
34
|
+
$$;
|
|
35
|
+
revoke all on function meta.app_activity(int) from public;
|
|
36
|
+
grant execute on function meta.app_activity(int) to public;
|
|
37
|
+
comment on function meta.app_activity(int) is 'The current application''s activity (page views, sign-ins, errors) for its administrators (098).';
|
|
@@ -7,7 +7,7 @@ open item and open an issue or pull request; see [CONTRIBUTING.md](../CONTRIBUTI
|
|
|
7
7
|
Legend: ✅ available · 🟡 partial (see notes) · ❌ not yet · ➖ not planned (a deliberate choice,
|
|
8
8
|
or better served by the PostgreSQL ecosystem; see the notes and [extensions](guide/15-extensions.md))
|
|
9
9
|
|
|
10
|
-
Last reviewed: 2026-10-14 (sprint 70: treemap, sunburst and timeline charts; sprint 69: dragging tasks on a Gantt chart; sprint 68: the Data Reporter's welcome page, Find my workspace; sprint 67: REST source catalogs from OpenAPI documents, a workspace's export and import (two rows added); sprint 66: a blueprint from an existing application; sprint 65: facet charts; sprint 64: approval vacation rules and expiration policies; sprint 63: range, box plot and stock charts; sprint 62: workspace preferences (SQL Workshop and RESTful services per workspace), extension links, Manage backups across applications, SQL Workshop utilities with object reports, About Database and a database monitor; sprint 61: the builder's screens compared with APEX 26.1: the workspace sign-in page, the Administration menu with workspace message, environment banner and utilization, the SQL Workshop home, the App Gallery, application groups and cross application reports (four rows added); sprint 60: isolated workspaces with their own database logins, row-level security on pgkiln's tables and workspace database roles, workspace administrators; sprint 59: the Page Designer's help pane, Quick edit from the developer toolbar; sprint 58: page groups; sprint 57: region templates hero, title bar, buttons container, inline dialog and drawer, wizard with wizard progress, the carousel; sprint 56: Generate DDL and Schema Comparison in the SQL Workshop, `pgkiln ddl` and `pgkiln compare`; sprint 55: an editable login page with a Login region and the Minimal page template, Forgot password through the application's mail service; sprint 54: interactive grid views, the single row view, group by and chart; sprint 53: application settings, user preferences and items kept per user, dynamic translations, `meta.data_export` and data export downloads, display image and geocoded address items; sprint 52: every dynamic action event and action, Ajax callbacks, an error handling function, the session timeout warning; sprint 51: checked imports, application backups, availability and Run only, feedback, type-specific attribute help; sprint 50: lost update detection, warn on unsaved changes, the URL and search regions with search configurations, the developer toolbar with a session state viewer, and e-mail through SMTP with OAuth2, Microsoft Graph, Amazon SES and HTTP APIs; import checks, application availability, property help and e-mail compared again; 2026-10-06: pgkiln 0.31.0, in progress: static application files and the Execute JavaScript dynamic action; region, item, dynamic action and process plug-ins; conditional and dynamic theme styles; XML and Excel in `meta.parse_data`, zips in SQL, `meta.v_boolean`; file items in S3-compatible object storage; map layers by the visible area and as vector tiles; a graphical query builder; tenants for workflows and tasks; application files as YAML and region static IDs; Lucide icons and icon modifiers; PWA push notifications; 0.30.0: 136 icons and an icon picker; an axe-core accessibility audit; cropping pictures; session sharing between applications; twenty-two built-in languages; 0.29.0: workspaces; the Iris base style; drawers; built-in template components including the metric card; Theme Roller dark-mode colours, live preview and template options on items and report columns; report selection across pages; instance settings; fourteen built-in languages; 0.28.0: AI with Claude and OpenAI; 0.27.0: Data Reporter; sample data generator; create application from several sheets, pasted data or existing tables; 0.26.0: working copies with a three-way merge; theme, library and boilerplate applications with subscriptions; 0.25.0: Gantt, pyramid and polar charts; map layers, clustering and server-side spatial filters; REST data sources that write back from forms and grids and synchronise into tables, OAuth2 password and refresh-token grants; debug messages per request and an install/upgrade log; `meta.web_request()` and `meta.parse_data()`; Theme Roller style variants and template options; 0.24.0: automations with several actions, error handling per row and runs from SQL; invoke-API workflow steps; Unload Data in the Data Workshop; create page wizards for cards, calendar, chart, map, faceted search, form and master-detail; create an application from a file; 0.23.0: interactive grid aggregates, frozen/moved/resized columns, layouts and saved grid reports, master-detail, row actions and copy/paste; download processes, execution chains in the background, workflow processes, branches to a function's URL or another app, the Dialog Closed event; number format masks, automatic time zone, runtime messages in German, French and Spanish; SQL scripts, Quick SQL, a query builder, XML loading and data load definitions; custom authentication, lists, page and application locks with developer comments, supporting objects; 0.22.0: keyset paging, report PDFs and REST collections streamed from a cursor, database-account authentication; 0.21.0: HTTP-header authentication behind a reverse proxy; 0.20.0: a popup list of values with server-side search; 0.19.0: row-range pagination, maximum row counts and row limits, lazy loading and caching of regions, streamed CSV/Excel downloads; 0.18.0: calendar week/day/list views with drag and drop, bubble/gauge/funnel/radar charts and drill-down, smart filters, a region display selector and more facet types, computations, conditional branches, build options, menu buttons, REST data sources and web credentials, rich text/Markdown, rating, combobox, date range and QR code items; 0.17.0: an App Builder home, workspace dashboard and utilities like APEX's; 0.16.0: a Page Designer with drag-and-drop layout, a code editor with autocomplete, template components and plug-ins, parallel branches and versions of workflows, the `pgkiln` command line with one file per component; 0.15.0: drop and paste files, heat maps, filtering a report by the map area; 0.14.0: stacked, combo, scatter and pie charts, several files per upload item; 0.13.0: map and tree regions; 0.12.0: REST modules in the builder; 0.11.0: workflows and Progressive Web Apps; 0.10.0: LDAP, SAML, "Keep me signed in", document templates, JSON loading, approvals and the task list; pgkiln installs no application, HR is an example).
|
|
10
|
+
Last reviewed: 2026-10-14 (sprint 73: the Create Application wizard on one page with page types and features; sprint 72: the runtime chrome compared with APEX 26.2's: the developer toolbar, the Iris look, the navigation bar's Help menu and Install button; sprint 71: generated applications compared with APEX 26.2's: labels, foreign key names in reports, file columns, format masks, the Home page and the dashboard; sprint 70: treemap, sunburst and timeline charts; sprint 69: dragging tasks on a Gantt chart; sprint 68: the Data Reporter's welcome page, Find my workspace; sprint 67: REST source catalogs from OpenAPI documents, a workspace's export and import (two rows added); sprint 66: a blueprint from an existing application; sprint 65: facet charts; sprint 64: approval vacation rules and expiration policies; sprint 63: range, box plot and stock charts; sprint 62: workspace preferences (SQL Workshop and RESTful services per workspace), extension links, Manage backups across applications, SQL Workshop utilities with object reports, About Database and a database monitor; sprint 61: the builder's screens compared with APEX 26.1: the workspace sign-in page, the Administration menu with workspace message, environment banner and utilization, the SQL Workshop home, the App Gallery, application groups and cross application reports (four rows added); sprint 60: isolated workspaces with their own database logins, row-level security on pgkiln's tables and workspace database roles, workspace administrators; sprint 59: the Page Designer's help pane, Quick edit from the developer toolbar; sprint 58: page groups; sprint 57: region templates hero, title bar, buttons container, inline dialog and drawer, wizard with wizard progress, the carousel; sprint 56: Generate DDL and Schema Comparison in the SQL Workshop, `pgkiln ddl` and `pgkiln compare`; sprint 55: an editable login page with a Login region and the Minimal page template, Forgot password through the application's mail service; sprint 54: interactive grid views, the single row view, group by and chart; sprint 53: application settings, user preferences and items kept per user, dynamic translations, `meta.data_export` and data export downloads, display image and geocoded address items; sprint 52: every dynamic action event and action, Ajax callbacks, an error handling function, the session timeout warning; sprint 51: checked imports, application backups, availability and Run only, feedback, type-specific attribute help; sprint 50: lost update detection, warn on unsaved changes, the URL and search regions with search configurations, the developer toolbar with a session state viewer, and e-mail through SMTP with OAuth2, Microsoft Graph, Amazon SES and HTTP APIs; import checks, application availability, property help and e-mail compared again; 2026-10-06: pgkiln 0.31.0, in progress: static application files and the Execute JavaScript dynamic action; region, item, dynamic action and process plug-ins; conditional and dynamic theme styles; XML and Excel in `meta.parse_data`, zips in SQL, `meta.v_boolean`; file items in S3-compatible object storage; map layers by the visible area and as vector tiles; a graphical query builder; tenants for workflows and tasks; application files as YAML and region static IDs; Lucide icons and icon modifiers; PWA push notifications; 0.30.0: 136 icons and an icon picker; an axe-core accessibility audit; cropping pictures; session sharing between applications; twenty-two built-in languages; 0.29.0: workspaces; the Iris base style; drawers; built-in template components including the metric card; Theme Roller dark-mode colours, live preview and template options on items and report columns; report selection across pages; instance settings; fourteen built-in languages; 0.28.0: AI with Claude and OpenAI; 0.27.0: Data Reporter; sample data generator; create application from several sheets, pasted data or existing tables; 0.26.0: working copies with a three-way merge; theme, library and boilerplate applications with subscriptions; 0.25.0: Gantt, pyramid and polar charts; map layers, clustering and server-side spatial filters; REST data sources that write back from forms and grids and synchronise into tables, OAuth2 password and refresh-token grants; debug messages per request and an install/upgrade log; `meta.web_request()` and `meta.parse_data()`; Theme Roller style variants and template options; 0.24.0: automations with several actions, error handling per row and runs from SQL; invoke-API workflow steps; Unload Data in the Data Workshop; create page wizards for cards, calendar, chart, map, faceted search, form and master-detail; create an application from a file; 0.23.0: interactive grid aggregates, frozen/moved/resized columns, layouts and saved grid reports, master-detail, row actions and copy/paste; download processes, execution chains in the background, workflow processes, branches to a function's URL or another app, the Dialog Closed event; number format masks, automatic time zone, runtime messages in German, French and Spanish; SQL scripts, Quick SQL, a query builder, XML loading and data load definitions; custom authentication, lists, page and application locks with developer comments, supporting objects; 0.22.0: keyset paging, report PDFs and REST collections streamed from a cursor, database-account authentication; 0.21.0: HTTP-header authentication behind a reverse proxy; 0.20.0: a popup list of values with server-side search; 0.19.0: row-range pagination, maximum row counts and row limits, lazy loading and caching of regions, streamed CSV/Excel downloads; 0.18.0: calendar week/day/list views with drag and drop, bubble/gauge/funnel/radar charts and drill-down, smart filters, a region display selector and more facet types, computations, conditional branches, build options, menu buttons, REST data sources and web credentials, rich text/Markdown, rating, combobox, date range and QR code items; 0.17.0: an App Builder home, workspace dashboard and utilities like APEX's; 0.16.0: a Page Designer with drag-and-drop layout, a code editor with autocomplete, template components and plug-ins, parallel branches and versions of workflows, the `pgkiln` command line with one file per component; 0.15.0: drop and paste files, heat maps, filtering a report by the map area; 0.14.0: stacked, combo, scatter and pie charts, several files per upload item; 0.13.0: map and tree regions; 0.12.0: REST modules in the builder; 0.11.0: workflows and Progressive Web Apps; 0.10.0: LDAP, SAML, "Keep me signed in", document templates, JSON loading, approvals and the task list; pgkiln installs no application, HR is an example).
|
|
11
11
|
|
|
12
12
|
## At a glance
|
|
13
13
|
|
|
@@ -36,7 +36,7 @@ two, REST source catalogs and the workspace export, with their features.)
|
|
|
36
36
|
| APEX | pgkiln | Notes |
|
|
37
37
|
|---|---|---|
|
|
38
38
|
| App Builder: create, edit, delete, run apps | ✅ | Builder at `/builder` |
|
|
39
|
-
| Create application wizard | ✅ | Blank app with its own database role and schema, started from a **boilerplate application** if wanted; **from a file**: CSV/TSV/XLSX/JSON/XML, where an Excel workbook with several sheets (or JSON with several arrays) becomes several tables, with a preview to include or leave out each sheet, edit table/column names, types and primary keys, and **foreign keys proposed** from matching columns; **from pasted data** (CSV/TSV text); **from existing tables** (pick the tables and views of a schema). Each gives a report and form per table, navigation and an optional dashboard (a chart per table), plus an optional faceted search for a single table, all created in one transaction. **Missing:** blueprints (26.1) |
|
|
39
|
+
| Create application wizard | ✅ | Blank app with its own database role and schema, started from a **boilerplate application** if wanted; **from a file**: CSV/TSV/XLSX/JSON/XML, where an Excel workbook with several sheets (or JSON with several arrays) becomes several tables, with a preview to include or leave out each sheet, edit table/column names, types and primary keys, and **foreign keys proposed** from matching columns; **from pasted data** (CSV/TSV text); **from existing tables** (pick the tables and views of a schema). Each gives a report and form per table, navigation and an optional dashboard (a chart per table), plus an optional faceted search for a single table, all created in one transaction. (sprint 73) **One page like APEX's**: name, icon and description, appearance (theme style, side or top menu, accent), a **page type per table** (interactive report with form, faceted search, cards, calendar, master detail, interactive grid, report, none; large tables proposed as a grid), **features** (About page, access control roles, activity reporting, feedback, theme style selection, PWA, push), settings (alias, authentication, first user, language) and a boilerplate under Advanced; a progress message, then straight to the new application. (sprint 71) The generated pages read like APEX's: human labels (abbreviations, run-together words, column and table comments), plural page and menu names with singular form titles, foreign keys shown by the parent's name in reports, `bytea` columns as one file item with their name/mime/size/updated columns, number format masks, a pencil per report row, the Dashboard after Home with *(none)* and top-N charts, and a Home page with a hero and a card per page. **Missing:** blueprints (26.1) |
|
|
40
40
|
| Create page wizards | ✅ | Report and form, interactive grid, form, cards, calendar, chart, map, faceted search and master-detail (stacked grids) from any table or view, with defaults from the catalog (columns, key, dates, positions, foreign keys), an optional modal form page and a navigation entry; also from SQL (`meta.generate_page`). No side-by-side or drill-down master-detail, no wizard for smart filters or trees |
|
|
41
41
|
| Page Designer | ✅ | IDE-style window (dark or light): component tree, a layout canvas with drag and drop (with keyboard and button alternatives) and a gallery of regions, items and buttons, a filterable property editor; undo/redo; panes become tabs on phones. Settings forms for report, grid, chart, cards, calendar, faceted search, smart filters, display selector, map, tree and template component regions. A code editor for SQL, PL/pgSQL, JSON and HTML with highlighting and autocomplete of tables, columns and `:ITEM` binds (no extra libraries). Drag and drop needs a mouse; on touch screens the Arrange buttons move components |
|
|
42
42
|
| Shared components | ✅ | Navigation menu, **lists** (static entries with nesting, badges, conditions, authorization and build options, or a query; for list regions, the navigation menu and the navigation bar), authorization schemes, build options, lists of values, application items and processes, access control, globalization, template components and plug-ins, web credentials, REST data sources, data load definitions, supporting objects |
|
|
@@ -65,7 +65,7 @@ two, REST source catalogs and the workspace export, with their features.)
|
|
|
65
65
|
| Interactive grid | ✅ | Inline edit, add and delete rows, lists of values, required columns, per-row errors, all-or-nothing save, signed row keys, search and paging; **aggregates** over the whole result (developer and user defined), **frozen columns**, column **reorder/resize/hide** (Actions → Columns, or drag and drop), per-user layouts and **saved grid reports** (private and public), **master-detail** (signed row selection, details refreshed in place), a **row actions menu** (edit, duplicate, delete, links) and **copy/paste** of cell ranges (tab-separated, spreadsheet compatible) ([chapter 4](guide/04-pages-and-regions.md)) |
|
|
66
66
|
| Interactive grid views: single row view, chart view, group by | ✅ | (sprint 54) **Single row view**: one row of the search as a form with first/previous/next/last and *Add row*, from the Actions or row actions menu, saved by the grid's own process with the same checks; **group by** and **chart** set up in the Actions menu over every row of the search, as for the interactive report; `views` limits them; Save comes back to the same search, page and view ([chapter 4](guide/04-pages-and-regions.md#grid-interactive-grid)). No pivot view on grids (the interactive report has one), no editing in the single row view of columns the grid doesn't show |
|
|
67
67
|
| Form (automatic row processing) | ✅ | Fetch, insert, update, delete, in a page or a modal dialog. Detects rows deleted meanwhile. (sprint 50) **Lost update detection** (APEX: *Prevent Lost Updates* and *Lock Row*): the page carries a checksum of the row's form columns (`meta.row_version`, independent of time zone and date format, as the app's role); *Save* and *Delete* lock the row and refuse when it changed meanwhile; off per form with `{"lost_update": false}` ([chapter 4](guide/04-pages-and-regions.md#form)) |
|
|
68
|
-
| Charts | ✅ | Bar, column, stacked, line, area, combination (columns + lines), scatter, bubble, donut, pie, gauge, funnel, radar, **Gantt** (start/end, progress, milestones, dependencies, a today line, a time axis from hours to years), **pyramid** (area-proportional segments, or two series back to back) and **polar** (polar area); (sprint 63) **range** (floating columns from low to high), **box plot** (from one value per row or five statistics) and **stock** (candlesticks from open, high, low and close); multi-series, tooltips, data table, palette checked for colour-vision deficiency; drill-down links on chart marks (checksummed, only to pages the user may open). Drawn on the server as SVG without inline styles. (sprint 69) **Gantt editing**: drag a task or its end, or the arrow keys, runs the region's SQL as the app's role. (sprint 70) **treemap** (squarified, two levels shown), **sunburst** (up to four rings) from `node_id` / `parent_id` columns, and **timeline** (lanes by a `series` column, points and periods, overlaps in rows). **Missing:** other Oracle JET types (e.g. picto, NBox, Sankey) |
|
|
68
|
+
| Charts | ✅ | Bar, column, stacked, line, area, combination (columns + lines), scatter, bubble, donut, pie, gauge, funnel, radar, **Gantt** (start/end, progress, milestones, dependencies, a today line, a time axis from hours to years), **pyramid** (area-proportional segments, or two series back to back) and **polar** (polar area); (sprint 63) **range** (floating columns from low to high), **box plot** (from one value per row or five statistics) and **stock** (candlesticks from open, high, low and close); multi-series, tooltips, data table, (sprint 71) a value axis with gridlines on horizontal bars and top-N with an *Other* bar (`"top": 10`), palette checked for colour-vision deficiency; drill-down links on chart marks (checksummed, only to pages the user may open). Drawn on the server as SVG without inline styles. (sprint 69) **Gantt editing**: drag a task or its end, or the arrow keys, runs the region's SQL as the app's role. (sprint 70) **treemap** (squarified, two levels shown), **sunburst** (up to four rings) from `node_id` / `parent_id` columns, and **timeline** (lanes by a `series` column, points and periods, overlaps in rows). **Missing:** other Oracle JET types (e.g. picto, NBox, Sankey) |
|
|
69
69
|
| Cards and metric cards (26.1 metric card template) | ✅ | Cards from SQL, with a KPI "metric" style |
|
|
70
70
|
| Calendar | ✅ | Month, week, day and list views (agenda list on phones); create on click (a checksummed link with the slot); drag and drop to move events through the developer's move SQL, run as the app's role (CSRF, a *who may drag* authorization, only events the user sees). Works without JavaScript; dragging adds on top ([chapter 4](guide/04-pages-and-regions.md#calendar)) |
|
|
71
71
|
| Faceted search | ✅ | Checkbox, range (predefined, or a custom from/to on numbers and dates), star rating and search facets with live counts that honour the other facets; exclude on checkbox facets (26.1). Values travel as query parameters, never as SQL text. (sprint 65) **Facet charts**: a bar or pie chart of a facet's counts, each mark filtering on its value |
|
|
@@ -166,7 +166,7 @@ two, REST source catalogs and the workspace export, with their features.)
|
|
|
166
166
|
| Icons (Font APEX 2.5) | ✅ | 136 line icons of pgkiln's own and (0.31) the **Lucide** set of about 1,600 more in the same line style, each served on its own; **modifiers** like Font APEX's (sizes, spin, rotate, flip, colours) and Font APEX names (`fa-users fa-lg`) where Lucide has the icon; a visual picker in the builder that searches all of them by name and search word ([chapter 9](guide/09-reference.md#icons)). Font APEX's own drawings are Oracle's, so icons look different and a few Font APEX names have no match |
|
|
167
167
|
| Accessibility | ✅ | Labels, keyboard, focus rings, reduced motion, table alternatives for charts, scrolling tables reachable from the keyboard; an automated WCAG 2.1 A/AA audit (axe-core) of every example page in light, dark and Iris and of the builder's main pages runs in CI with no violations allowed. Not a manual expert audit |
|
|
168
168
|
| Drawers, top/bottom dialogs (26.1) | ✅ | Modal pages open as a centred dialog or as a drawer from the left, right, top or bottom edge, in three sizes, sliding in (without animation for reduced motion); on phones full screen ([chapter 4](guide/04-pages-and-regions.md#dialogs-and-drawers)). Not yet: a footer slot for inline drawers |
|
|
169
|
-
| New "Iris" default style (26.1) | ✅ | Base style **Iris
|
|
169
|
+
| New "Iris" default style (26.1) | ✅ | Base style **Iris**, the default for new applications, light by default with the user's choice of dark: (sprint 72) like APEX 26's: a white body, a dark warm-grey header with an accent strip and a dark menu, 4 px corners, region headers with a rule, a dark primary button, a large page title; light and dark palettes checked for WCAG AA contrast. The earlier look stays as **Lavender** ([chapter 14](guide/14-globalization.md#base-styles-iris-lavender-and-standard)) |
|
|
170
170
|
| Progressive Web App (push notifications: 23.1) | ✅ | Per app: installable (manifest, icon, standalone), service worker, offline pages (opt-in, wiped at sign-in/out), **forms sent offline queued on the device and sent later** (files included, once only, under the same user), location, camera and barcode items. (0.31) **Push notifications**: users turn them on per device (My account, or the dynamic action `push_subscribe`); `meta.send_push(user, title, body, page, items)` and a `send_push` process queue them, sent after the commit, encrypted for the device (RFC 8291) and signed with the application's own VAPID key (RFC 8292, stored encrypted, never exported); links signed for the recipient; devices end at sign-out, a new password, deactivation or removed access ([chapter 17](guide/17-mobile.md#push-notifications)). No images or action buttons in notifications |
|
|
171
171
|
|
|
172
172
|
## Globalization
|
|
@@ -219,7 +219,7 @@ two, REST source catalogs and the workspace export, with their features.)
|
|
|
219
219
|
| Workspace message, environment banner, workspace utilization, preferences and extension links (Manage Service) | ✅ | (sprint 61) An **Administration** menu in the icon rail; administrators and workspace administrators set a **workspace message** (on the App Builder home) and an **environment banner** (a coloured label on every builder page of the workspace), and see **workspace utilization** (applications, pages, page views, users, static files, schema storage) ([chapter 3](guide/03-builder.md#workspace-message-and-environment-banner)). (sprint 62) **Workspace preferences**: the SQL Workshop and the applications' RESTful services (REST modules) on or off per workspace; **extension links** in an Extensions menu of the rail ([chapter 3](guide/03-builder.md#workspace-preferences)). **Missing:** the account login controls of APEX's preferences (pgkiln's password policy and sign-in throttling are installation-wide) |
|
|
220
220
|
| Instance administration, install/upgrade logs (26.1) | ✅ | Versioned migrations (`npm run db:migrate`), every run logged; Workspace utilities → **Installation** (administrators): server version, install and upgrade runs with errors, applied migrations, and warnings for migrations the database misses or the server doesn't know ([chapter 3](guide/03-builder.md)). Workspace utilities → **Instance settings**: session length and sign-in throttling (stored in the database, over the environment variables) and an overview of the server's configuration without secrets; a server whose database lacks migrations says so (503) or applies them (`MIGRATE_ON_START`). Other settings stay environment variables |
|
|
221
221
|
| Debug messages | ✅ | Debug levels 1–9 per app; `meta.debug(level, text)` and `meta.debug_enabled(level)` from application SQL (APEX_DEBUG); timed entries per request (page steps, regions, processes, branches, errors, SQL notices); Activity → **Debug messages** viewer per page view with filters and the slowest step highlighted; retention 1–90 days; password item values are never recorded ([chapter 6](guide/06-processing.md)). (sprint 50) Debug for **one session** from the developer toolbar, the application staying out of debug. **Missing:** debug entries for background jobs and REST requests |
|
|
222
|
-
| Developer toolbar, session state viewer | ✅ | (sprint 50) Developers signed in to the builder see a toolbar on the pages of their applications in the same browser: App Builder, the application, **Edit page** (Page Designer), **Session** (the session state viewer: user, roles, session, language, time zone, debug level, this page's items, application items and other pages' items; passwords never shown; clear the page's items) **Quick edit** (sprint 59: click a region, item or button to open it in the Page Designer) and **Debug** for this session only. A separate random token (cookie path `/a`, HttpOnly) of a live builder session of a developer of the application's workspace ([chapter 3](guide/03-builder.md#developer-toolbar)). **
|
|
222
|
+
| Developer toolbar, session state viewer | ✅ | (sprint 50) Developers signed in to the builder see a toolbar on the pages of their applications in the same browser: App Builder, the application, **Edit page** (Page Designer), **Session** (the session state viewer: user, roles, session, language, time zone, debug level, this page's items, application items and other pages' items; passwords never shown; clear the page's items) **Quick edit** (sprint 59: click a region, item or button to open it in the Page Designer) and **Debug** for this session only. A separate random token (cookie path `/a`, HttpOnly) of a live builder session of a developer of the application's workspace ([chapter 3](guide/03-builder.md#developer-toolbar)). (sprint 72) A compact bar of icons with tooltips like APEX's, centred at the bottom, **Customize** (the Theme Roller) and **Info**, hidden to a slim tab when not used, docked at the bottom, top, left or right; the page keeps room for it |
|
|
223
223
|
| Feedback (users send feedback from a page, developers answer) | ✅ | (sprint 51) With *Users can send feedback* on, the navigation bar's **Feedback** link opens a page for a comment, idea or problem about the page (optional rating), with the user's earlier feedback and the developers' answers; developers read, filter, set a status and answer under Application → Feedback ([chapter 3](guide/03-builder.md#feedback)). No screenshots, no e-mail to developers |
|
|
224
224
|
| Automatic application backups, page groups | ✅ | (sprint 51) **Backups**: before every import that replaces an application (CLI, MCP, working copy merge, restore), daily when it changed, and by hand; the newest 25 (configurable) are kept; download and restore from the builder ([chapter 3](guide/03-builder.md#backups)); (sprint 62) Workspace utilities → **Manage backups** across the workspace's applications, with a backup of all of them at once. (sprint 58) **Page groups**: Shared Components → Page groups, a page's *Page group*, the page list by group with a filter ([chapter 3](guide/03-builder.md#page-groups)) |
|
|
225
225
|
| Application availability (Available, Developers only, Restricted access, Unavailable; build status *Run only*) | ✅ | (sprint 51) Available, available to developers only (a builder session in the same browser), restricted to named users, or unavailable with a message, for pages, file downloads, REST modules and PostgREST; build status **Run only** refuses builder changes as if the application were locked, while `pgkiln import --replace` still deploys. Installation settings: not exported, kept by an import ([chapter 3](guide/03-builder.md#availability-and-build-status)) |
|
package/docs/guide/03-builder.md
CHANGED
|
@@ -246,23 +246,33 @@ The list is `examples/gallery/gallery.json`; add your own starters there as blue
|
|
|
246
246
|
|
|
247
247
|
### Creating an application
|
|
248
248
|
|
|
249
|
-
**Create** (a tile, or `/builder/create`)
|
|
249
|
+
**Create** (a tile, or `/builder/create`) is one page, like APEX's Create Application wizard. Links at the top
|
|
250
|
+
start from a file, pasted data, a blueprint or the App Gallery instead. Then:
|
|
250
251
|
|
|
251
|
-
| Field | Meaning |
|
|
252
|
-
|
|
253
|
-
|
|
|
254
|
-
|
|
|
255
|
-
|
|
|
256
|
-
|
|
|
257
|
-
|
|
|
258
|
-
|
|
|
252
|
+
| Section | Field | Meaning |
|
|
253
|
+
|---|---|---|
|
|
254
|
+
| Data | Pages on the tables of | The parsing schema: an existing schema (*Show its tables* lists them under Pages), or a new, empty one named after the alias |
|
|
255
|
+
| Application | Name | Display name, shown in the header. Proposed from the schema and selected when you click it, so typing replaces it |
|
|
256
|
+
| | Description, Icon | Shown on the home page's hero and the About page |
|
|
257
|
+
| Appearance | Theme style, Navigation, Accent colour | Iris, Lavender or Standard; a side or top menu; an own accent colour |
|
|
258
|
+
| Pages | a page type per table | *Interactive report with form*, *Faceted search*, *Cards*, *Calendar* (a table with a date column), *Master detail* (a table another table refers to), *Interactive grid*, *Report* or *No page*. Tables with a single-column primary key get a modal form with their report, faceted search, cards and calendar; views and tables without such a key can't have a form or a grid. Proposed: a report with form, an interactive grid for a table of more than 100,000 rows, a report for a view. *Dashboard*: a chart per table |
|
|
259
|
+
| Features | | *About page* (in a Help menu), *Access control* (authorization schemes `CONTRIBUTOR` and `READER` next to `ADMIN`, for the roles admin, contributor and reader), *Activity reporting* (page 9010 for administrators: page views per day and the latest activity, from `meta.app_activity`), *Feedback*, *Theme style selection* (users may choose light or dark), *Install as an app* (PWA) and *Push notifications* (needs `PGKILN_SECRET_KEY`) |
|
|
260
|
+
| Settings | Alias | Lowercase URL name: `inventory` gives `/a/inventory` |
|
|
261
|
+
| | Authentication | *App users* (a login page and a user list), *HTTP header* (a trusted reverse proxy names the user, see [chapter 8](08-security.md#http-header-authentication-reverse-proxy)), *Database accounts* (PostgreSQL login roles and their passwords, see [chapter 8](08-security.md#database-accounts-postgresql-roles)), *Custom* (your own PL/pgSQL function, see [chapter 8](08-security.md#custom-authentication-a-plpgsql-function)) or *None* (a public app) |
|
|
262
|
+
| | First user / Password | The first user; they get the `admin` role. An existing account is reused (its password isn't changed) |
|
|
263
|
+
| | Language | The application's primary language |
|
|
264
|
+
| Advanced | Start from | Shown when there are **boilerplate** applications (Settings → Application type): their pages, shared components and settings are copied into the new application, which keeps its own name, alias, role and authentication ([application types](#application-types-and-subscriptions)) |
|
|
259
265
|
|
|
260
266
|
Creating the app also:
|
|
261
267
|
|
|
262
268
|
- creates the database role `app_<alias>` with `SELECT/INSERT/UPDATE/DELETE` on all tables,
|
|
263
269
|
`USAGE` on sequences and `EXECUTE` on functions in the schema, plus **default privileges**,
|
|
264
270
|
so tables you create later (as the owner, e.g. in the SQL Workshop) are usable by the app straight away;
|
|
265
|
-
- creates page 1 *Home*, a navigation entry, and an authorization scheme `ADMIN` (role `admin`)
|
|
271
|
+
- creates page 1 *Home*, a navigation entry, and an authorization scheme `ADMIN` (role `admin`);
|
|
272
|
+
- shows a progress message while it works and then opens the new application's page in the builder,
|
|
273
|
+
with what was created (and anything left out) as a message.
|
|
274
|
+
|
|
275
|
+
Everything is created in one transaction: when a page can't be made, nothing is.
|
|
266
276
|
|
|
267
277
|
The parsing schema can't be `meta`, `information_schema` or a `pg_*` schema.
|
|
268
278
|
|
|
@@ -334,18 +344,50 @@ most 4 MB of text; upload larger data as a file.
|
|
|
334
344
|
|
|
335
345
|
### Creating an application from existing tables
|
|
336
346
|
|
|
337
|
-
**Create
|
|
338
|
-
`information_schema` and the `pg_*` schemas aren't offered)
|
|
339
|
-
|
|
347
|
+
**Create**, then a schema under *Data* (`/builder/create?schema=…`; pgkiln's `meta`,
|
|
348
|
+
`information_schema` and the `pg_*` schemas aren't offered): each table and view gets a page type
|
|
349
|
+
under *Pages* (above), or *No page*. The application gets that schema as its parsing schema and a role
|
|
340
350
|
`app_<alias>` with the grants of a blank application on the schema (so **all** tables of the schema,
|
|
341
|
-
not only the
|
|
342
|
-
|
|
343
|
-
key, a report page; a navigation entry each; and optionally a dashboard (a chart per table, as above;
|
|
351
|
+
not only the ones with pages). The pages are made with `meta.generate_page`, with a navigation entry
|
|
352
|
+
each; and optionally a dashboard (a chart per table, as above;
|
|
344
353
|
for existing tables the repeating values come from the planner statistics, so `ANALYZE` a table that
|
|
345
354
|
was never analyzed). Everything is created in one transaction. Foreign keys to tables in another
|
|
346
355
|
schema show in forms as select lists that the app's role may not be allowed to read: grant it, or
|
|
347
356
|
pick a schema that holds them all.
|
|
348
357
|
|
|
358
|
+
#### What the generated pages look like
|
|
359
|
+
|
|
360
|
+
The wizards (every *Create application* flow and the page wizards) make pages that read like APEX's:
|
|
361
|
+
|
|
362
|
+
- **Labels**: names become words. `snake_case` and `camelCase` are split, run-together words are
|
|
363
|
+
recognised (`hiredate` → *Hire Date*, `deptno` → *Department Number*) and common abbreviations are
|
|
364
|
+
expanded (`emp` → *Employee*, `dept` → *Department*, `sal` → *Salary*, `comm` → *Commission*, `mgr` →
|
|
365
|
+
*Manager*, `qty` → *Quantity*, `desc` → *Description*, `pct` → *Percent*, `crm` → *CRM*, `id` → *ID*).
|
|
366
|
+
A foreign key column drops its `_id`/`no` suffix (`deptno` → *Department*), and a column named after
|
|
367
|
+
the table's first letter drops it (`emp.ename` → *Name*). A short `COMMENT ON COLUMN` (one line, at
|
|
368
|
+
most 60 characters, no full stop) is the label; a longer one becomes the item's help text. A short
|
|
369
|
+
`COMMENT ON TABLE` names the pages.
|
|
370
|
+
- **Plural and singular**: report pages, cards and the navigation menu use the plural (*Employees*),
|
|
371
|
+
forms and dialog titles the singular (*Employee*).
|
|
372
|
+
- **Reports** show a foreign key's parent by its display column (a name, title or label, else its first
|
|
373
|
+
text column): *Manager* shows KING, *Department* shows SALES. The key itself stays in the query,
|
|
374
|
+
hidden, so filters can use it. A row starts with a pencil that opens the form.
|
|
375
|
+
- **Files**: a `bytea` column becomes one file upload item that also fills the columns that go with it
|
|
376
|
+
(`<col>_name`/`_filename`, `<col>_mime`/`_mime_type`, `<col>_size`, `<col>_updated`; or `filename`
|
|
377
|
+
and `mime_type` next to the only `bytea` column). Reports leave these columns out. Columns named like
|
|
378
|
+
*photo*, *image* or *logo* accept pictures only.
|
|
379
|
+
- **Numbers** get a format mask with group separators (and the scale's decimals for `numeric(p,s)`),
|
|
380
|
+
in reports and forms alike, in the application's language (*2,850.00*); keys get none.
|
|
381
|
+
- The **Dashboard** comes right after *Home* in the menu; its charts are titled *Employees by Manager*,
|
|
382
|
+
rows without a value are labelled *(none)*, and bar charts show the ten largest values (the rest is
|
|
383
|
+
one *Other* bar). Tables with row-level security are left out (the application's role may see none of
|
|
384
|
+
their rows); the result page says which.
|
|
385
|
+
- The **Home** page has a hero with the application's icon and name, and a card per page of the menu
|
|
386
|
+
(a list `HOME_PAGES`, Shared Components → Lists). A blank application gets the hero only.
|
|
387
|
+
- An **About** page (page 9000: the application's description, or the pages of its menu) in a **Help**
|
|
388
|
+
menu of the header's navigation bar (a list `NAVBAR`, the application's navigation bar list).
|
|
389
|
+
- New applications use the **Iris** base style in the **light** theme; users may switch to dark.
|
|
390
|
+
|
|
349
391
|
### Creating an application from a blueprint
|
|
350
392
|
|
|
351
393
|
**Create → From a blueprint** (`/builder/blueprints`; APEX 26.1: *Blueprints*, spec-driven
|
|
@@ -635,8 +677,12 @@ Chapters 4–7 describe every component type and property.
|
|
|
635
677
|
## Developer toolbar
|
|
636
678
|
|
|
637
679
|
While you are signed in to the builder, the pages of your applications show the **developer
|
|
638
|
-
toolbar**
|
|
639
|
-
|
|
680
|
+
toolbar** when you run them in the same browser (APEX: the Runtime Developer Toolbar): a compact bar
|
|
681
|
+
of icons, centred at the bottom, each with a tooltip. It isn't shown to anyone else, nor inside
|
|
682
|
+
dialogs. The page keeps room for it, so it never covers the menu's last entry or a report's pager.
|
|
683
|
+
After a few seconds without use it shrinks to a slim tab at the edge; point at it or Tab to it to
|
|
684
|
+
bring it back. **Settings** (the last icon) docks it at the bottom, top, left or right and turns the
|
|
685
|
+
hiding off (kept in your browser). It has:
|
|
640
686
|
|
|
641
687
|
| Entry | Does |
|
|
642
688
|
|---|---|
|
|
@@ -645,6 +691,8 @@ Toolbar). It isn't shown to anyone else, nor inside dialogs, and it can be folde
|
|
|
645
691
|
| **Edit page *n*** | This page in the Page Designer |
|
|
646
692
|
| **Quick edit** | (with JavaScript) Point at a region, item or button of the page (it is outlined) and click it: it opens selected in the Page Designer, in the builder's tab (APEX: Quick Edit). Click the button again or press Esc to stop |
|
|
647
693
|
| **Session** | The **session state viewer**: the user, roles, session id, language, time zone and debug level; the values of this page's items, the application items and the items of other pages in the session. A password item's value is never shown. *Clear the items of page n* empties this page's items in the session (APEX: Clear Cache) |
|
|
694
|
+
| **Customize** | The application's Theme Roller in the builder |
|
|
695
|
+
| **Info** | The application, the page, the user and the developer |
|
|
648
696
|
| **Debug** | Records [debug messages](06-processing.md#debug-messages) for **this session only**, at the chosen level, while the application itself stays out of debug (*Application (n)* when the application has a level of its own). *View debug* opens the recorded requests |
|
|
649
697
|
|
|
650
698
|
How it knows you: signing in to the builder gives the browser a second, separate random token for
|
|
@@ -274,11 +274,15 @@ Run these as the owner (in the SQL Workshop, `psql` or migrations):
|
|
|
274
274
|
|
|
275
275
|
| Function | Description |
|
|
276
276
|
|---|---|
|
|
277
|
-
| `meta.generate_crud(app, table, report_page, form_page, label default null, icon default 'table')` | Report page + modal form page + menu entry for a table |
|
|
277
|
+
| `meta.generate_crud(app, table, report_page, form_page, label default null, icon default 'table')` | Report page + modal form page + menu entry for a table, with the column names as labels (kept as it was for existing scripts; `meta.generate_page` *report_form* makes the labelled pages of the wizards) |
|
|
278
278
|
| `meta.generate_grid(app, table, page, label default null, icon default 'grid')` | Interactive grid page + menu entry |
|
|
279
279
|
| `meta.generate_page(app, kind, table, page, options default '{}')` | The create page wizards: `kind` is `form`, `cards`, `calendar`, `chart`, `map`, `facets`, `master_detail` (or `report_form`, `grid`). Options left out take the defaults of `meta.wizard_defaults`; JSON `null` means none. Returns the new page's id (below) |
|
|
280
280
|
| `meta.wizard_defaults(kind, table)` | The options a wizard proposes for a table, from the catalog |
|
|
281
281
|
| `meta.wizard_catalog(table)` | The columns as the wizards see them: kind (`text`, `number`, `date`, `timestamp`, `boolean`, `point`, `geometry`, `binary`, `other`), key, unique, foreign key and the parent's display column |
|
|
282
|
+
| `meta.wizard_label(name)`, `meta.wizard_table_label(table, plural default true)`, `meta.wizard_column_label(table, column)` | (097) The labels of the wizards: `hiredate` → *Hire Date*, `hr.emp` → *Employees* / *Employee*, `deptno` → *Department*; short comments win ([what the generated pages look like](03-builder.md#what-the-generated-pages-look-like)) |
|
|
283
|
+
| `meta.wizard_report(table, columns default null)` | (097) A report on a table as the wizards make it: `{"source", "hidden", "headings", "formats"}` (foreign keys joined to their parent's display column) |
|
|
284
|
+
| `meta.app_activity(days default 30)` | (098) The current application's page views, sign-ins and errors of the last days (1 to 366, at most 10,000 rows, no IP addresses), for a signed-in user with the `admin` role of that application; others get an error. The Activity page of the Create Application wizard reads it |
|
|
285
|
+
| `meta.wizard_files(table)` | (097) The `bytea` columns and the columns holding their file name, mime type, size and change time |
|
|
282
286
|
| `meta.export_app(alias)` | The application as JSON (`pgkiln/2` format) |
|
|
283
287
|
| `meta.import_app(json, alias default null)` | Import an export, optionally under a new alias; returns the new app id |
|
|
284
288
|
| `meta.hash_password(text)` | A bcrypt hash for `meta.app_user.password_hash` / `meta.developer.password_hash` |
|
|
@@ -293,7 +297,7 @@ Options of `meta.generate_page` (all optional; column names must be columns of t
|
|
|
293
297
|
|
|
294
298
|
| Kind | Options |
|
|
295
299
|
|---|---|
|
|
296
|
-
| all | `label` (page name and menu entry), `icon`, `nav` (add a navigation entry; default true, false for `form`) |
|
|
300
|
+
| all | `label` (page name and menu entry; default the table's plural label, singular for `form`), `form_label` (the title of a form page; default the singular label), `icon`, `nav` (add a navigation entry; default true, false for `form`) |
|
|
297
301
|
| `form` | `columns` (array), `mode` (`normal` or `modal`), `return_page` |
|
|
298
302
|
| `cards` | `title`, `subtitle`, `body`, `badge`, `form_page` |
|
|
299
303
|
| `calendar` | `start`, `end`, `title`, `drag` (boolean), `form_page` |
|
|
@@ -62,7 +62,7 @@ What's missing is listed in the [feature parity matrix](../apex-feature-parity.m
|
|
|
62
62
|
| Application date format mask | Settings → Globalization → Date format (Oracle-style masks) |
|
|
63
63
|
| Number format masks (`FML999G999G990D00`) on columns and items | `{"formats": {...}}` on report, grid and cards columns, `{"format_mask": "..."}` on charts and number/display items ([chapter 14](14-globalization.md#number-formats)) |
|
|
64
64
|
| Automatic Time Zone | Settings → Globalization → Time zone and Automatic time zone; My account → Time zone ([chapter 14](14-globalization.md#time-zones)) |
|
|
65
|
-
| Universal Theme's default style (26.1: *Iris*) | Base style *Iris* (the default for new applications) or *Standard* ([chapter 14](14-globalization.md#base-styles-iris-and-standard)) |
|
|
65
|
+
| Universal Theme's default style (26.1: *Iris*) | Base style *Iris* (the default for new applications), *Lavender* or *Standard* ([chapter 14](14-globalization.md#base-styles-iris-lavender-and-standard)) |
|
|
66
66
|
| Theme styles, *Enable End Users to Choose Theme Style* | Theme style (automatic/light/dark) and *Users may choose light or dark*; Theme Roller style variants with *Users may choose a style* ([chapter 14](14-globalization.md#style-variants-theme-roller)) |
|
|
67
67
|
| Template Options (regions, buttons) | *Template options* in the Page Designer: CSS classes from a fixed list ([chapter 4](04-pages-and-regions.md#template-options)) |
|
|
68
68
|
| ORDS | Not needed to serve apps; REST APIs with PostgREST, see [below](#ords-and-postgrest) |
|
|
@@ -116,7 +116,7 @@ src/
|
|
|
116
116
|
processes.ts download (file or zip from a query, safe headers), workflow processes, configuration checks of chains
|
|
117
117
|
logic.ts computations, branches (page, URL, function returning a URL, another application) and their conditions
|
|
118
118
|
render.ts page chrome (nav, breadcrumb), dynamic action JSON, theme (the page's nonce'd <style>, light/dark and style switches)
|
|
119
|
-
styles.ts base styles (BASE_STYLES: Iris, Standard; baseStyleOf → html data-style), Theme Roller style variants: fixed lists (fonts, sizes, corners), parseStyle/appStyles checks, the request's
|
|
119
|
+
styles.ts base styles (BASE_STYLES: Iris, Lavender, Standard; baseStyleOf → html data-style), Theme Roller style variants: fixed lists (fonts, sizes, corners), parseStyle/appStyles checks, the request's
|
|
120
120
|
style (user choice, default), themeCss() (only hex values and constants reach the CSS)
|
|
121
121
|
template-options.ts template options: the fixed CSS class list per region and button, templateClasses() (unknown values ignored)
|
|
122
122
|
regions.ts region shell + chart (drill-down links, gauge settings)/cards/dynamic dispatch with row limits, lazy placeholder and cache, buttons (menu buttons, badges)
|
|
@@ -212,7 +212,7 @@ Under **Settings → Theme**, *Theme style* is **Automatic** (follow the device,
|
|
|
212
212
|
has the same choice. The choice is saved on the account, so it applies in every application that
|
|
213
213
|
allows it. For public applications it's kept in a cookie.
|
|
214
214
|
|
|
215
|
-
## Base styles: Iris and Standard
|
|
215
|
+
## Base styles: Iris, Lavender and Standard
|
|
216
216
|
|
|
217
217
|
Every application has a **base style** (Settings → Theme → *Base style*; APEX: the Universal Theme's theme style,
|
|
218
218
|
whose default in 26.1 is *Iris*). It sets the colours of the light and the dark theme, the corners, the font and the
|
|
@@ -220,12 +220,16 @@ shadows of the whole application:
|
|
|
220
220
|
|
|
221
221
|
| Base style | Look |
|
|
222
222
|
|---|---|
|
|
223
|
-
| **Iris** (the default for new applications) |
|
|
223
|
+
| **Iris** (the default for new applications) | (0.42, like APEX 26's Iris) A white body, a dark warm-grey header (`#3a3632`) with a thin accent strip and a dark menu, a blue accent (`#2b62c4`, `#84aef2` in dark mode), 4 px corners, regions with a rule under their header, a dark primary button and a large bold page title on the body (no title band) |
|
|
224
|
+
| **Lavender** | pgkiln's Iris until 0.41: indigo accent (`#5146d8`), a deep indigo header, cool light greys, 12 px corners, softer shadows, rounded navigation items and pill-shaped primary buttons |
|
|
224
225
|
| **Standard** | pgkiln's look until 0.28: blue accent, navy header, 8 px corners. Applications created before 0.29 keep it until you change it |
|
|
225
226
|
|
|
226
227
|
The accent and header colours under Settings → Theme, and the style variants below, change the base style's
|
|
227
228
|
colours (in the light theme). Choosing a colour equal to a base style's own stores nothing, so switching the base
|
|
228
|
-
style later changes it too. All text colours of
|
|
229
|
+
style later changes it too. All text colours of the base styles meet WCAG AA contrast in light and dark mode.
|
|
230
|
+
|
|
231
|
+
New applications start in the **light** theme (Settings → Theme → *Mode*), with *Users may choose light or dark*
|
|
232
|
+
on, as in APEX.
|
|
229
233
|
|
|
230
234
|
## Style variants (Theme Roller)
|
|
231
235
|
|
package/docs/guide/17-mobile.md
CHANGED
|
@@ -10,7 +10,7 @@ the home screen with its own icon, full screen, and working on when the network
|
|
|
10
10
|
|
|
11
11
|
| Setting | What it does |
|
|
12
12
|
|---|---|
|
|
13
|
-
| Installable | Adds a web app manifest and a service worker to the application. Phones offer "Add to home screen" / "Install"; the app then opens full screen, without the browser bar |
|
|
13
|
+
| Installable | Adds a web app manifest and a service worker to the application. Phones offer "Add to home screen" / "Install"; the app then opens full screen, without the browser bar. (0.42) Where the browser offers the installation (Chrome, Edge), the header shows an **Install app** button (APEX: the navigation bar's Install App entry) |
|
|
14
14
|
| Name under the icon | The short name on the home screen (the application's name when empty) |
|
|
15
15
|
| Keep visited pages on the device | Pages a user opened are shown again when there is no connection (with a notice that they may be out of date) |
|
|
16
16
|
| Keep forms sent without a connection | Forms submitted offline are kept on the device and sent when the connection is back |
|