- 
- {{ capGen.version }}
-
-
- {{ capGen.version }}
- login_id INTEGER,) => UUID[]
inherited BOOLEAN DEFAULT FALSE
login_id INTEGER,) => BOOLEAN
role_id UUID,
inherited BOOLEAN DEFAULT FALSE
login_id INTEGER,) => BOOLEAN
role_ids UUID[],
inherited BOOLEAN DEFAULT FALSE
mail_id INTEGER,) => INTEGER
attach_record_id INTEGER,
attach_attribute_id UUID
id INTEGER,Dopo aver elaborato un'email, questa dovrebbe essere eliminata; direttamente (mail_delete) o dopo aver memorizzato i suoi allegati (mail_delete_after_attach).", + "mail_send":"instance.mail_send(
from_list TEXT,
to_list TEXT,
cc_list TEXT,
subject TEXT,
body TEXT
subject TEXT,) => INTEGER
body TEXT,
to_list TEXT DEFAULT '',
cc_list TEXT DEFAULT '',
bcc_list TEXT DEFAULT '',
account_name TEXT DEFAULT NULL,
attach_record_id INTEGER DEFAULT NULL,
attach_attribute_id UUID DEFAULT NULL
- {{ capGen.version }}
- 
@@ -315,6 +384,12 @@ let MyAdminModules = {
{{ capApp.update }}
+ {{ capApp.changeLog }}
+ 
diff --git a/www/comps/app.css b/www/comps/app.css
index 9b30775e..2562d1c7 100644
--- a/www/comps/app.css
+++ b/www/comps/app.css
@@ -69,7 +69,7 @@
--light-contrast: calc(100% - (var(--light-depth)/3)); /* stuff to contrast with read content, backgrounds mostly */
/* depth based colors */
- --color-bg: hsl(315,10%, var(--light-contrast));
+ --color-bg: hsl(315,10%,var(--light-contrast));
--color-bg-font: hsl(0, 0%, var(--light-contrast));
--color-border: hsl(0, 0%, calc(60% - (var(--light-depth) * 3) ));
--color-font: hsl(0, 0%, var(--light-read));
@@ -78,8 +78,9 @@
--color-accent1: hsl(311,57%,calc(40% - var(--light-depth))); /* field captions */
--color-accent2: hsl(127,86%,calc(96% - var(--light-depth))); /* calendar/gantt weekend */
- --color-accent3: hsl(199,11%,calc(92% - var(--light-depth))); /* list/calendar/gantt entry hover */
- --color-accent3-alt: hsl(199,11%,calc(86% - var(--light-depth))); /* list/calendar/gantt entry active */
+ --color-accent3: hsl(199,11%,calc(92% - var(--light-depth))); /* menu/list/calendar entry hover */
+ --color-accent3-alt: hsl(199,11%,calc(86% - var(--light-depth))); /* menu/list/calendar entry active */
+ --color-accent4: hsl(339, 4%,calc(61% - var(--light-depth))); /* gantt entry */
--color-error: hsl(0, 84%,calc(61% - var(--light-depth)));
--color-success: hsl(113,44%,calc(44% - var(--light-depth)));
--color-action: hsl(146,37%,calc(37% - var(--light-depth)));
@@ -134,6 +135,7 @@ body { --depth:9; }
.gantt-header.lower { --depth:5; }
.gantt-group { --depth:0; }
.gantt-group:nth-child(odd) { --depth:2; }
+.gantt-line { --depth:-2; }
.button { --depth:4; }
.button.background:focus { --depth:0; }
.button.background:hover { --depth:0; }
@@ -741,7 +743,8 @@ table td.maximum{
/* HTML documentation */
.html-docs{
text-align:justify;
- line-height:140%;
+ font-size:110%;
+ line-height:150%;
padding:0px 16px !important;
}
.html-docs h1{
@@ -753,6 +756,22 @@ table td.maximum{
.html-docs h3{
margin:14px 0px 0px 0px;
}
+.html-docs img{
+ width:100%;
+ margin:5px 0px;
+ box-shadow:1px 1px 3px var(--color-shade);
+}
+.html-docs li img{
+ margin:10px 0px;
+}
+.html-docs p,
+.html-docs img{
+ max-width:1000px;
+}
+.html-docs ol,
+.html-docs ul{
+ max-width:950px;
+}
/* transitions*/
@@ -870,6 +889,7 @@ table td.maximum{
--color-accent2: hsl(127,06%,calc(25% - (1.50% * var(--depth)) ));
--color-accent3: hsl(199,11%,calc(39% - (1.50% * var(--depth)) ));
--color-accent3-alt:hsl(199,11%,calc(32% - (1.50% * var(--depth)) ));
+ --color-accent4: hsl(339, 4%,calc(61% - (1.50% * var(--depth)) ));
--color-form-builder-actions:hsl(195,17%,29%,1.00);
--color-form-builder-columns:hsl(247,17%,46%,0.42);
diff --git a/www/comps/app.js b/www/comps/app.js
index fa8398c9..6f60b83a 100644
--- a/www/comps/app.js
+++ b/www/comps/app.js
@@ -2,7 +2,7 @@ import MyDialog from './dialog.js';
import MyFeedback from './feedback.js';
import MyHeader from './header.js';
import MyLogin from './login.js';
-import {hasAccessToAnyMenu} from './shared/access.js';
+import {getStartFormId} from './shared/access.js';
import {genericError} from './shared/error.js';
import {getCaptionForModule} from './shared/language.js';
import {openLink} from './shared/generic.js';
@@ -124,8 +124,8 @@ let MyApp = {
return false;
// module is accessible if start form is set and user has access to any menu
- let accessible = module.formId !== null
- && that.hasAccessToAnyMenu(module.menus,that.menuAccess);
+ let formIdStart = getStartFormId(module,that.access);
+ let accessible = formIdStart !== null;
// ignore hidden modules
if(that.moduleIdMapOptions[module.id].hidden)
@@ -160,7 +160,7 @@ let MyApp = {
accessible:accessible,
caption:caption,
children:children,
- formId:module.formId,
+ formId:formIdStart,
iconId:module.iconId,
id:module.id,
name:module.name,
@@ -194,6 +194,7 @@ let MyApp = {
httpMode:function() { return location.protocol === 'http:'; },
// stores
+ access: function() { return this.$store.getters.access; },
activated: function() { return this.$store.getters['local/activated']; },
appVersion: function() { return this.$store.getters['local/appVersion']; },
customLogo: function() { return this.$store.getters['local/customLogo']; },
@@ -209,7 +210,6 @@ let MyApp = {
isAtDialog: function() { return this.$store.getters.isAtDialog; },
isAtFeedback: function() { return this.$store.getters.isAtFeedback; },
isMobile: function() { return this.$store.getters.isMobile; },
- menuAccess: function() { return this.$store.getters.access.menu; },
pageTitle: function() { return this.$store.getters.pageTitle; },
settings: function() { return this.$store.getters.settings; }
},
@@ -228,7 +228,7 @@ let MyApp = {
// externals
genericError,
getCaptionForModule,
- hasAccessToAnyMenu,
+ getStartFormId,
openLink,
// general app states
@@ -261,8 +261,6 @@ let MyApp = {
this.stateChange();
},
wsBackendRequest:function(res) {
-
- let trans;
switch(res.ressource) {
// affects admins only (reloads happen in maintenance mode only)
// add busy counters to also block admins that did not request the schema reload
@@ -279,12 +277,17 @@ let MyApp = {
this.initSchema();
break;
+ // affects admins only (builder can be actived only in maintenance mode)
+ case 'builder_mode_changed':
+ this.$store.commit('builder',res.payload);
+ break;
+
// affects everyone logged in
case 'reauthorized':
if(!this.appReady)
return;
- trans = new wsHub.transaction();
+ let trans = new wsHub.transaction();
trans.add('lookup','get',{name:'access'},this.retrievedAccess);
trans.send(this.genericError);
break;
@@ -343,6 +346,7 @@ let MyApp = {
this.$store.commit('builder',r.payload.builder);
this.$store.commit('productionMode',r.payload.productionMode);
this.$store.commit('pageTitle',this.pageTitle); // apply new app short name to page
+ this.$store.commit('schema/languageCodes',r.payload.languageCodes);
this.$store.commit('schema/timestamp',r.payload.schemaTimestamp);
this.publicLoaded = true;
this.stateChange();
diff --git a/www/comps/builder/builder.css b/www/comps/builder/builder.css
index 054b9bef..f3590933 100644
--- a/www/comps/builder/builder.css
+++ b/www/comps/builder/builder.css
@@ -294,8 +294,30 @@
flex-flow:row nowrap;
margin:0px 0px 6px 0px;
}
+.builder-query .fixed-limit{
+ display:flex;
+ flex-flow:row nowrap;
+ align-items:center;
+ justify-content:space-between;
+}
/* relation */
+.builder-relations .sub-component{
+ display:flex;
+ flex-flow:column nowrap;
+ align-items:flex-start;
+ padding:6px 12px 12px 12px;
+ margin:0px 15px 10px;
+ border:1px solid var(--color-border);
+ border-top:none;
+ border-radius:0px 0px 5px 5px;
+}
+.builder-relations .sub-component table{
+ margin:10px 0px 20px;
+}
+.builder-relations .sub-component table td{
+ padding:3px 5px;
+}
.builder-relation{
flex:1 1 auto;
flex-direction:column;
diff --git a/www/comps/builder/builderDocs.js b/www/comps/builder/builderDocs.js
index 6958a0d9..b37a5155 100644
--- a/www/comps/builder/builderDocs.js
+++ b/www/comps/builder/builderDocs.js
@@ -33,6 +33,7 @@ let MyBuilderDocs = {
return this.docs
.replace(/href="#(.*?)"/g,'href="'+window.location+'#'+this.idPlaceholder+`$1`+'"')
.replace(/id="(.*?)"/g,'id="'+this.idPlaceholder+`$1`+'"')
+ .replace(/src="(.*?)"/g,'src="docs/'+`$1`+'"')
;
},
diff --git a/www/comps/builder/builderFieldColumns.js b/www/comps/builder/builderFieldColumns.js
index 09b78dd6..7becf6f7 100644
--- a/www/comps/builder/builderFieldColumns.js
+++ b/www/comps/builder/builderFieldColumns.js
@@ -171,22 +171,24 @@ let MyBuilderFieldColumnOptions = {
v-if="isSubQuery"
@set-choices="setQuery('choices',$event)"
@set-filters="setQuery('filters',$event)"
+ @set-fixed-limit="setQuery('fixedLimit',$event)"
@set-joins="setQuery('joins',$event)"
@set-lookups="setQuery('lookups',$event)"
@set-orders="setQuery('orders',$event)"
@set-relation-id="setQuery('relationId',$event)"
- :allow-choices="false"
- :allow-orders="true"
- :builder-language="builderLanguage"
+ :allowChoices="false"
+ :allowOrders="true"
+ :builderLanguage="builderLanguage"
:choices="column.query.choices"
- :data-fields="dataFields"
+ :dataFields="dataFields"
:filters="column.query.filters"
+ :fixedLimit="column.query.fixedLimit"
:joins="column.query.joins"
- :joins-parents="[joins]"
+ :joinsParents="[joins]"
:lookups="column.query.lookups"
- :module-id="moduleId"
+ :moduleId="moduleId"
:orders="column.query.orders"
- :relation-id="column.query.relationId"
+ :relationId="column.query.relationId"
/>
@@ -545,7 +545,7 @@ let MyBuilderFields = {
JSON.parse(JSON.stringify(field.query.filters))
),
orders:field.query.orders,
- limit:10
+ limit:field.query.fixedLimit !== 0 ? field.query.fixedLimit : 0
},this.getSqlPreviewOk);
trans.send(this.$root.genericError);
},
diff --git a/www/comps/builder/builderForm.js b/www/comps/builder/builderForm.js
index 6bc21b63..5e9f24b1 100644
--- a/www/comps/builder/builderForm.js
+++ b/www/comps/builder/builderForm.js
@@ -164,22 +164,24 @@ let MyBuilderForm = {
@index-removed="fieldQueryRemoveIndex($event)"
@set-choices="fieldQuerySet('choices',$event)"
@set-filters="fieldQuerySet('filters',$event)"
+ @set-fixed-limit="fieldQuerySet('fixedLimit',$event)"
@set-joins="fieldQuerySet('joins',$event)"
@set-lookups="fieldQuerySet('lookups',$event)"
@set-orders="fieldQuerySet('orders',$event)"
@set-relation-id="fieldQuerySet('relationId',$event)"
- :allow-lookups="fieldQueryEdit.content === 'list' && fieldQueryEdit.csvImport"
- :allow-orders="true"
- :builder-language="builderLanguage"
+ :allowLookups="fieldQueryEdit.content === 'list' && fieldQueryEdit.csvImport"
+ :allowOrders="true"
+ :builderLanguage="builderLanguage"
:choices="fieldQueryEdit.query.choices"
- :data-fields="dataFields"
+ :dataFields="dataFields"
:filters="fieldQueryEdit.query.filters"
+ :fixedLimit="fieldQueryEdit.query.fixedLimit"
:joins="fieldQueryEdit.query.joins"
- :module-id="module.id"
+ :moduleId="module.id"
:orders="fieldQueryEdit.query.orders"
:lookups="fieldQueryEdit.query.lookups"
- :relation-id="fieldQueryEdit.query.relationId"
- :relation-id-start="fieldQueryRelationIdStart"
+ :relationId="fieldQueryEdit.query.relationId"
+ :relationIdStart="fieldQueryRelationIdStart"
/>
@@ -194,15 +196,17 @@ let MyBuilderForm = {
@set-lookups="lookups = $event"
@set-orders="orders = $event"
@set-relation-id="relationId = $event"
- :allow-choices="false"
- :builder-language="builderLanguage"
+ :allowChoices="false"
+ :allowFixedLimit="false"
+ :builderLanguage="builderLanguage"
:choices="choices"
:filters="filters"
+ :fixedLimit="0"
:joins="joins"
:lookups="lookups"
- :module-id="form.moduleId"
+ :moduleId="form.moduleId"
:orders="orders"
- :relation-id="relationId"
+ :relationId="relationId"
/>
@@ -772,18 +776,10 @@ let MyBuilderForm = {
}
this.fieldQueryEdit.columns = colsCloned;
},
- fieldQuerySet:function(content,value) {
- let query = JSON.parse(JSON.stringify(this.fieldQueryEdit.query));
-
- switch(content) {
- case 'relationId': query.relationId = value; break;
- case 'joins': query.joins = value; break;
- case 'filters': query.filters = value; break;
- case 'orders': query.orders = value; break;
- case 'lookups': query.lookups = value; break;
- case 'choices': query.choices = value; break;
- }
- this.fieldQueryEdit.query = query;
+ fieldQuerySet:function(name,value) {
+ let v = JSON.parse(JSON.stringify(this.fieldQueryEdit.query));
+ v[name] = value;
+ this.fieldQueryEdit.query = v;
},
// backend calls
diff --git a/www/comps/builder/builderModules.js b/www/comps/builder/builderModules.js
index bde11a07..2a86347a 100644
--- a/www/comps/builder/builderModules.js
+++ b/www/comps/builder/builderModules.js
@@ -9,12 +9,85 @@ let displayArrow = function(state) {
return state ? 'images/triangleDown.png' : 'images/triangleRight.png';
};
+let MyBuilderModulesItemStartForm = {
+ name:'my-builder-modules-item-start-form',
+ template:`| {{ capGen.order }} | +{{ capGen.role }} | +{{ capApp.startForm }} | ++ | |
+ {{ capApp.startFormsExplanation }} +
+| + | + | {{ capApp.policyActions }} | +{{ capApp.policyFunctions }} | ++ | ||||
| {{ capGen.order }} | +{{ capGen.role }} | +{{ capApp.policyActionSelect }} | +{{ capApp.policyActionUpdate }} | +{{ capApp.policyActionDelete }} | +{{ capApp.policyFunctionExcl }} | +{{ capApp.policyFunctionIncl }} | ++ | |
+ {{ capApp.policyExplanation }} +
+ +Updated 2021-09-28
+Updated 2021-11-07
This is the documentation for building applications with the REI3 application platform. REI3 is a server application that runs on-premise or in the cloud, on Windows and Linux. REI3 applications are served as a progressive web app that runs on any modern browser and can be installed on clients directly. To learn how to setup and administrate REI3, please refer to the admin documentation.
-With REI3, simple applications can be created very quickly, while complex and scalable applications are also facilitated. It can be compared to low-code products, but also offers access to low-level entities such as database triggers, indexes, sub queries, custom functions, complex relationships and so on. In this regard REI3 can be used to create powerful applications, while benefiting greatly from existing knowledge of relational database systems. It is not necessary to have deep knowledge of database systems to build applications in REI3; however by learning about them, more functionality is available to application authors.
-Building REI3 applications is done exclusively with the integrated, graphical interface, simply called 'the Builder'. The Builder is included in all REI3 releases but must be enabled before it can be accessed.
-Before accessing the Builder there are a few important concepts to understand:
-Using the Builder enables full write access to application schemas inside a REI3 instance. Changing an application schema will directly manipulate underlying data structures, potentially destroying existing data in the instance but also in target instances when transferring an application.
-Important precautions
+This is the documentation for building REI3 applications. REI3 is a free, open-source business application platform, which can run on-premise or from the cloud, on Windows and Linux. To learn how to setup and administrate REI3, please refer to the admin documentation.
+REI3´s primary purpose is to fulfill business software requirements. Simple applications, like a system that manages company event attendance, can be built within a single hour. More complex applications, like absence management or a system to execute mail campaigns, require more time but are also easily buildable with REI3. Organizations using REI3 can save time and money by reducing dependency on costly software solutions for simple requirements, while cheaply addressing complex, niche requirements that no fitting solution is available for.
+Most people with IT administration skills can utilize REI3 to address software requirements; it is however very useful to know and understand relational databases to make use of all features. REI3 provides access to low-level entities, such as database indexes, triggers, sub queries, functions and so on. With some background knowledge, complex relationships, business logic, access control as well as performance tuning can be implemented to build powerful, fast and scalable applications.
+Building REI3 applications is done exclusively with an integrated, graphical utility, simply called 'the Builder'. The Builder is included in all REI3 releases.
+Using the Builder, individuals and organizations can create or change applications. Finished applications can then be exported as file and re-imported into other REI3 instances. This way applications can be built on one system and transferred to another. It is also possible to share applications with others by exchanging REI3 files or using online repositories.
+Changing an application with the Builder can result in changes to the underlying data structure, potentially deleting data in the instance but also in other instances when transferring an application. Precautions must be taken accordingly:
Once you understand these concepts, and have a non-productive instance ready, you can enable the Builder by changing the option 'builder' to 'true' within the file 'config.json' inside your REI3 application directory. After a restart of REI3, and enabling the maintenance mode in the admin UI, the Builder icon will appear on the top-left corner of the REI3 page header.
+To enable the Builder, you need to login into a running REI3 instance with an admin user. After enabling the maintenance mode, which will kick all non-admin users from the system, the Builder can be switched on. Once activated, the Builder can be accessed from its icon on the top-left corner of the main menu.
+
Going into the Builder UI you will be presented with a list of installed application schemas (empty if none are installed) as well as an application export dialog. To create a new application, you only need to decide on an unique name and click on the save icon. The name is important as it must stay unique even after transferring to another instance.
-For the official repository of REI3, we decided to use author prefixes to avoid naming conflicts (ours is 'r3_'). You are free to choose any name you wish; an unique prefix is required however if you want to publish applications in the official REI3 repository. You can request a prefix by contacting us.
+Going into the Builder UI you will be presented with a list of installed applications. To create a new application, you only need to decide on a name and click on the save icon. The name can become important later as application names need to stay unique within a given REI3 instance. It is however no problem the change the name later.
+
To play around and see working examples, you can install applications from the REI3 repository from the admin UI. In a non-productive instance you can install, change, delete and re-install applications at any time. Installing finished applications can help with understanding how these are built and how specific options are used.
+
Creating a new application is straightforward. After opening the Builder, a list of installed applications is presented to you. The first line is reserved for creating new applications. By entering an unique name for the application and clicking the save icon, a new application is generated. You can then open the application to add things like data storage, menus, forms and much more.
+Creating a new application is straightforward. After opening the Builder, a list of installed applications is presented to you. The first line is reserved for creating new applications. By entering a unique name for the application and clicking the save icon, a new application is generated. You can then open the application to add things like data storage, menus, forms and so on.
There a few options when creating or updating the application itself:
Some options depend on other entities being created first (other applications to build on, forms to select as start form, icons to show). When creating an application these can be skipped and added/changed later.
+Some options depend on other entities being created first (other applications to build on, forms to select as start form, icons to show). When creating an application these can be skipped and updated later.
In addition, a couple of non-editable meta data fields are shown. These are set when an updated application is exported. Please refer to Application transfers for more details.
Relations and attributes are referenced in forms to display, create or update data in lists, fields, calendars and so on. They are also accessible in custom functions for complex data manipulation, calculations or other data related actions.
To store data for any entity, you create a relation - this will automatically create a corresponding database table with the same name. REI3 enforces valid names when things like relations are created. Optionally, you can also specify data retention settings for the relation.
-Relations are central to managing data in REI3. They contain all records, their attributes (e. g. their data), indexes (mostly for performance tuning), presets (predefined records) and triggers (automatically executed functions). To store anything, relations must be populated with attributes.
+
Relations are central to managing data in REI3. They contain all records, their values (following their attributes), indexes (mostly for performance tuning), presets (predefined records), triggers (automatically executed functions) and policies.
An attribute is a data field for each record in a relation. When creating an attribute, a database column is added to its relation table with the same name.
+
Adding an attribute has many more options available compared to relations:
Relationship attributes use foreign keys to enforce the existence of referenced records. When a record that serves as relationship target is deleted, the foreign key becomes invalid. This also occurs, although more rarely, when the referenced key of such a record is changed. To deal with these cases, you can specify a desired behavior for 'ON DELETE' (referenced record is deleted) and 'ON UPDATE' (key of referenced record is changed):
Presets are predefined records that are shipped with your application. A preset consists of a name as well as attribute values. The preset name only serves to reference to the preset inside the Builder - it is not visible to any end user. When your application is transferred to a target instance, one record for each preset is created in the corresponding relation. All defined attribute values are applied to this record.
+
When you define your preset, you can choose to protect it and/or its attribute values. Protecting the preset itself, blocks deletion of its associated record, while protecting attribute values blocks updating these values. The protection settings can be mixed to serve different purposes:
Functions in REI3 are PL/pgSQL functions. PL/pgSQL or Procedural Language/PostgreSQL is a programming language of the underlying database system that REI3 is running on (PostgreSQL). To learn more about writing PL/pgSQL, please refer to the official documentation for this language.
By writing functions, complex data manipulation tasks can be achieved. Functions can be executed with relation triggers, called from other functions or regularly by using function schedules.
-REI3 includes dynamic placeholders so that all references to an application schema (relations, attributes and other functions) are upgrade safe - this includes safe renaming and blocking of deletion in case entities are still referenced. As long as these placeholders are used, you cannot easily break your functions when making changes to your applications. Make sure to only ever use placeholders to read or write from/to the database, otherwise the stability of the system can be negatively affected.
+
REI3 includes dynamic placeholders so that all references to application entities (relations, attributes and other functions) are upgrade safe - this includes safe renaming and blocking of deletion in case entities are still referenced. As long as these placeholders are used, you cannot easily break your functions when making changes to your applications. Make sure to only ever use placeholders to read or write from/to the database, otherwise the stability of the system can be negatively affected.
In addition to functions from applications, instance functions are available to expose data or features from the REI3 instance. These can be used to read configuration settings (like the public hostname), get context information (like the login ID used to access the database) or execute tasks (like sending emails). To learn more about instance functions, please refer to the integrated help texts in the Builder UI for functions.
Triggers in REI3 are PostgreSQL database triggers. Database triggers react to events in a database and serve to apply logic, check inputs or block certain actions. When inserting, updating or deleting records in a relation, a trigger executes a defined function. In REI3, triggers also serve to access internal functions, exposed by the current instance. These instance functions are used to get information from the instance (like the ID of the current login) or execute certain actions (like sending emails).
@@ -201,11 +210,16 @@A relation policy can limit what specific records are accessible to a logged in user via their role memberships. This is done by setting filter functions for specific actions. While forms, lists, input fields and other frontend elements can also filter records, relation polices are applied globally and cannot be circumvented by changing the frontend. Relation policies are also 'quiet', meaning that users are not informed about missing access - they simply see different records.
+
To create a policy, a role must be connected to at least one action (display, change, delete). If records should be filtered, an 'allow' (whitelist) or 'block' (blacklist) filter function is used. A filter function is just a regular function that returns an array of record IDs (as in 'INTEGER[]' or 'bigint ARRAY'); the record IDs must match the relation for which the policy is defined. With the help of instance functions, such as 'has_role()' or 'get_login_id()', filter functions limit what records are accessible based on the currently logged in user.
+Polices have a defined order. The first policy matching the attempted action of the logged in user with the selected role, is applied. If the user has multiple roles, only the first matching policy is applied. If no filtering is desired, a role can be assigned all actions and both filter functions kept empty; this enables full access. If no policy is matched, full access is also granted.
When data is changed in REI3 you can choose to automatically keep copies of these changes. These change retention settings are defined for relations. If nothing is set, no data changes are kept. Every relation has 2 settings for defining data change retention:
Changes are visible to users in forms that access corresponding relations via the change log window. This will show all changes corresponding to joined relations (see Queries), but only for attributes that are accessible to the user via data input fields. If a user has access to a data field, and changes are available, they will be visible without further permissions being required.
The change retention cleanup job can be configured to run more or less often in the admin UI.
Roles serve to grant access within REI3. There are currently two distinct areas of access:
+Roles are used to control what a user can see and do in an application. Roles control:
Roles in REI3 are always cumulative - the more roles a user has, the more access is available. Following that, there is no 'deny' option. When you need to deny a group of users access, you remove the corresponding access from the currently used role and create a second role granting this specific access. This second role is then only assigned to users that should still receive this access. In general, it serves to have a role concept that is as simple as possible. Complexity will inevitably come to any access definition with time and should therefore be reduced as much as possible early on.
-When creating a role, you need to choose an unique role name within your application. Titles and descriptions serve to explain the role to administrators of other REI3 instances as they will be shown in the admin UI. They are not visible to non-admin users.
+Roles in REI3 are cumulative - the more roles a user has, the more access is available. Following that, there is no 'deny' option. When you need to deny a group of users access, you remove the corresponding access from the role and create a second one, granting this specific access. This second role is then only assigned to users that should still receive this access. In general, it serves to have a role concept that is as simple as possible.
+When creating a role, you need to choose a unique role name within your application. Titles and descriptions serve to explain the role to administrators of other REI3 instances as they will be shown in the admin UI. They are not visible to non-admin users.
Roles can be members of other roles. This enables access inheritance with no fixed limit on how many levels of inheritance are allowed. A user logging in, receives access following assigned roles and the memberships of these roles (and the memberships of those roles, and so on).
-When applications build on other applications (see Building on applications) usually some access to the other application´s data is necessary. This is solved by making your roles members of roles from the other application. In many cases data access is desired but users from one application should not see user interfaces from the other; this is solved by creating data only roles (no menu access specified) with which users only get access to data.
-Lastly, the option 'assignable' controls whether a role is directly assignable to a user. If set to 'false' the specific role is hidden in the admin UI and can only be used via membership of other roles. This can be useful for data only roles or for complex role hierarchies.
+When applications build on other applications (see Building on applications) usually some access to the other application´s data is necessary. This is solved by making your roles members of roles from other applications. In many cases data access is desired but users from one application should not see user interfaces from the other; this is solved by creating 'data only' roles (no menu access specified).
+Lastly, the option 'assignable' controls whether a role is directly assignable to a user. If set to 'false' the specific role is hidden in the admin UI and can only be assigned indirectly via membership of other roles. This can be useful for 'data only' roles or for complex role hierarchies.
Besides managing data, most systems require some kind of frontend. For this purpose, REI3 includes forms to display and manipulate data and menus to navigate your application.
Forms serve to show and manipulate data. Besides menus and complimentary functions (change logs, help pages, etc.), everything you see inside a REI3 application is defined within a form. When creating a form, you can specify the following:
+Forms serve to show and manipulate data. Besides menus and complimentary functions (change logs, help pages, etc.), everything you see inside a REI3 application is defined within a form.
+
When creating a form, you can specify the following:
Independently of what kind of form it is, forms are entirely comprised of fields. Fields serve to create layouts, manipulate data, execute actions and more. Available fields are shown in the sidebar of the form UI inside the Builder, depending on what the form has access to. These types of fields exist:
When designing complex lists with many joins, sub queries, groupings, filters and so on, logic errors or badly chosen configuration options can result in non-desirable data sets. To troubleshoot this, a SQL-preview function is available on the list field when inside the builder UI. This function returns the raw SQL that is being used to retrieve the current list data. With this preview, you can directly see how the chosen options affect the final SQL query. Regardless of the chosen configuration, each list retrieval only ever executes a single SQL, including all joins, sub queries and so on.
Calendar fields work very similar to list fields. They have their own query like list fields and can use the same columns and configuration options. Please refer to list fields for detailed explanations.
-Besides the same options that are available for list fields, calendar fields have a few specific ones; these are used to generate and style the calendar entries:
+Besides options that are also available to list fields, calendar fields have additional options for generating and styling the calendar entries:
Besides selecting relations, if more than one record is to be handled (lists/calendar fields), sorting can be applied to the results. Sorting is applied to the selected attribute (chosen via relation index + attribute name) in the defined order; when multiple sorting options are defined, results are sorted by the first, then the second and so on.
As the name implies, query filters filter query results. They are used in list/calendar fields and in relationship inputs (fields showing relationship attributes).
+As the name implies, query filters filter query results. They are used in forms, lists, calendars and in relationship inputs (fields showing relationship attributes).
Filters are made up from filter lines. Each line contains an AND/OR connector (first line is always AND), two filter criteria (to compare them) and an operator (equals, greater than, etc.). Additionally filter lines can be grouped with left and right brackets to create more complex AND/OR conditions. Some operators do not require a second filter criteria - 'IS NULL' for example just checks the first criteria against NULL.
Query filters can be defined in two ways:
When Building on applications, you can choose to copy the entire menu structure from another application. This is can be useful when you intent to extend another application; you copy the original menu structure, change target forms and add your own, custom menu entries.
Sometimes it is useful to connect the currently logged in user to a record from within your application. To assign a personal, employee or a customer contact record for example.
+
To enable this, an integer attribute can be placed on any of your relations. This attribute will then contain the login ID (which also is an integer). Once the login attribute exists, you have two options to update it:
Depending on the specific case, different approaches to application extension are possible.
@@ -566,14 +588,14 @@Applications are exported on the Builder start page. To start the export process you select the desired application and run an export check. This check will compare the current state of the application to the last known version. If any changes exist, a new version must be created before an export is possible. By creating a new version target instances understand that there are changes to apply. In order to export any changes, an application must be set to 'export changes' in the admin UI for applications. You should only do this for your own applications.
Important notice: When you build on applications from other authors, these are dependencies that are automatically exported together with your application. To protect against accidentally making changes to applications from others, all applications are in the state 'do not export changes' by default. While in this state, the last imported version of the application is exported and not the potentially changed version, accessible in the Builder. If you decide to export new versions for applications built by others, you potentially risk loss of your changes as well as data loss, when a new version from the original author is installed. You can safely build on other applications without making direct changes.
-Ultimately, the export will generate a compressed zip file, which includes your application and all its dependencies. Within the zip file, each application is represented as a *.json file, which contains the corresponding schema and a signature, created with your private key. Applications that were not changed are exported with their original schema and signature.
+Ultimately, the export will generate a compressed zip file, which includes your application and all its dependencies. Within the zip file, each application is represented as a *.json file, which contains the corresponding application structure and a signature, created with your private key. Applications that were not changed are exported as they were with their original signature.
Applications can be imported to REI3 instances in two ways:
When you attempt to import your application into another REI3 instance, the signature of the application schema is checked against a list of trusted public keys. Only applications which signature can be successfully compared to these trusted public keys can be imported. You can add your public key to any REI3 instance within the admin UI.
+When you attempt to import your application into another REI3 instance, the signature of the application is checked against a list of trusted public keys. Only applications which signature can be successfully compared to these trusted public keys can be imported. You can add your public key to any REI3 instance within the admin UI.
Applications are either installed or updated when they are imported. All changes made to the applications or their dependencies are automatically applied by REI3. Should there be a problem, the entire import process is reverted even if multiple applications were affected. Import issues can be checked inside the admin UI by increasing the log level for 'transfers' and repeating the import.
When running many local or offline REI3 instances, it can be sensible to host your own REI3 application repository. It is also possible to host your own repository in the cloud, accessible to anyone. This is done by setting up a REI3 instance and installing the 'REI3 repository' application; this is the same application we use to host the central REI3 repository.
diff --git a/www/docs/en_us_builder_pics/admin_config.png b/www/docs/en_us_builder_pics/admin_config.png new file mode 100644 index 00000000..66994ca4 Binary files /dev/null and b/www/docs/en_us_builder_pics/admin_config.png differ diff --git a/www/docs/en_us_builder_pics/attributes.png b/www/docs/en_us_builder_pics/attributes.png new file mode 100644 index 00000000..526e09b4 Binary files /dev/null and b/www/docs/en_us_builder_pics/attributes.png differ diff --git a/www/docs/en_us_builder_pics/form.png b/www/docs/en_us_builder_pics/form.png new file mode 100644 index 00000000..fefdfe0c Binary files /dev/null and b/www/docs/en_us_builder_pics/form.png differ diff --git a/www/docs/en_us_builder_pics/forms.png b/www/docs/en_us_builder_pics/forms.png new file mode 100644 index 00000000..942c5669 Binary files /dev/null and b/www/docs/en_us_builder_pics/forms.png differ diff --git a/www/docs/en_us_builder_pics/function.png b/www/docs/en_us_builder_pics/function.png new file mode 100644 index 00000000..25d41db2 Binary files /dev/null and b/www/docs/en_us_builder_pics/function.png differ diff --git a/www/docs/en_us_builder_pics/login_form.png b/www/docs/en_us_builder_pics/login_form.png new file mode 100644 index 00000000..8ee50ef6 Binary files /dev/null and b/www/docs/en_us_builder_pics/login_form.png differ diff --git a/www/docs/en_us_builder_pics/menus.png b/www/docs/en_us_builder_pics/menus.png new file mode 100644 index 00000000..a21e6da6 Binary files /dev/null and b/www/docs/en_us_builder_pics/menus.png differ diff --git a/www/docs/en_us_builder_pics/nm_relationship.png b/www/docs/en_us_builder_pics/nm_relationship.png new file mode 100644 index 00000000..e08b1dce Binary files /dev/null and b/www/docs/en_us_builder_pics/nm_relationship.png differ diff --git a/www/docs/en_us_builder_pics/policies.png b/www/docs/en_us_builder_pics/policies.png new file mode 100644 index 00000000..0f8607a0 Binary files /dev/null and b/www/docs/en_us_builder_pics/policies.png differ diff --git a/www/docs/en_us_builder_pics/presets.png b/www/docs/en_us_builder_pics/presets.png new file mode 100644 index 00000000..c5236b2e Binary files /dev/null and b/www/docs/en_us_builder_pics/presets.png differ diff --git a/www/docs/en_us_builder_pics/relations.png b/www/docs/en_us_builder_pics/relations.png new file mode 100644 index 00000000..0e9830a8 Binary files /dev/null and b/www/docs/en_us_builder_pics/relations.png differ diff --git a/www/docs/en_us_builder_pics/repo_install.png b/www/docs/en_us_builder_pics/repo_install.png new file mode 100644 index 00000000..81f4aa07 Binary files /dev/null and b/www/docs/en_us_builder_pics/repo_install.png differ diff --git a/www/docs/en_us_builder_pics/start.png b/www/docs/en_us_builder_pics/start.png new file mode 100644 index 00000000..7509263e Binary files /dev/null and b/www/docs/en_us_builder_pics/start.png differ diff --git a/www/docs/en_us_builder_pics/start_form.png b/www/docs/en_us_builder_pics/start_form.png new file mode 100644 index 00000000..bb343c42 Binary files /dev/null and b/www/docs/en_us_builder_pics/start_form.png differ diff --git a/www/docs/en_us_builder_pics/start_language.png b/www/docs/en_us_builder_pics/start_language.png new file mode 100644 index 00000000..16813c13 Binary files /dev/null and b/www/docs/en_us_builder_pics/start_language.png differ diff --git a/www/externals/vue.js b/www/externals/vue.js index 1abc270f..4204a49d 100644 --- a/www/externals/vue.js +++ b/www/externals/vue.js @@ -931,8 +931,6 @@ var Vue = (function (exports) { get: shallowReadonlyGet }); - const toReactive = (value) => isObject(value) ? reactive(value) : value; - const toReadonly = (value) => isObject(value) ? readonly(value) : value; const toShallow = (value) => value; const getProto = (v) => Reflect.getPrototypeOf(v); function get$1(target, key, isReadonly = false, isShallow = false) { @@ -1321,6 +1319,8 @@ var Vue = (function (exports) { def(value, "__v_skip" /* SKIP */, true); return value; } + const toReactive = (value) => isObject(value) ? reactive(value) : value; + const toReadonly = (value) => isObject(value) ? readonly(value) : value; function trackRefValue(ref) { if (isTracking()) { @@ -1350,7 +1350,6 @@ var Vue = (function (exports) { } } } - const convert = (val) => isObject(val) ? reactive(val) : val; function isRef(r) { return Boolean(r && r.__v_isRef === true); } @@ -1360,13 +1359,19 @@ var Vue = (function (exports) { function shallowRef(value) { return createRef(value, true); } + function createRef(rawValue, shallow) { + if (isRef(rawValue)) { + return rawValue; + } + return new RefImpl(rawValue, shallow); + } class RefImpl { constructor(value, _shallow) { this._shallow = _shallow; this.dep = undefined; this.__v_isRef = true; this._rawValue = _shallow ? value : toRaw(value); - this._value = _shallow ? value : convert(value); + this._value = _shallow ? value : toReactive(value); } get value() { trackRefValue(this); @@ -1376,17 +1381,11 @@ var Vue = (function (exports) { newVal = this._shallow ? newVal : toRaw(newVal); if (hasChanged(newVal, this._rawValue)) { this._rawValue = newVal; - this._value = this._shallow ? newVal : convert(newVal); + this._value = this._shallow ? newVal : toReactive(newVal); triggerRefValue(this, newVal); } } } - function createRef(rawValue, shallow) { - if (isRef(rawValue)) { - return rawValue; - } - return new RefImpl(rawValue, shallow); - } function triggerRef(ref) { triggerRefValue(ref, ref.value ); } @@ -1488,7 +1487,8 @@ var Vue = (function (exports) { function computed(getterOrOptions, debugOptions) { let getter; let setter; - if (isFunction(getterOrOptions)) { + const onlyGetter = isFunction(getterOrOptions); + if (onlyGetter) { getter = getterOrOptions; setter = () => { console.warn('Write operation failed: computed value is readonly'); @@ -1499,7 +1499,7 @@ var Vue = (function (exports) { getter = getterOrOptions.get; setter = getterOrOptions.set; } - const cRef = new ComputedRefImpl(getter, setter, isFunction(getterOrOptions) || !getterOrOptions.set); + const cRef = new ComputedRefImpl(getter, setter, onlyGetter || !setter); if (debugOptions) { cRef.effect.onTrack = debugOptions.onTrack; cRef.effect.onTrigger = debugOptions.onTrigger; @@ -1516,14 +1516,7 @@ var Vue = (function (exports) { // Note: for a component to be eligible for HMR it also needs the __hmrId option // to be set so that its instances can be registered / removed. { - const globalObject = typeof global !== 'undefined' - ? global - : typeof self !== 'undefined' - ? self - : typeof window !== 'undefined' - ? window - : {}; - globalObject.__VUE_HMR_RUNTIME__ = { + getGlobalThis().__VUE_HMR_RUNTIME__ = { createRecord: tryWrap(createRecord), rerender: tryWrap(rerender), reload: tryWrap(reload) @@ -1534,19 +1527,22 @@ var Vue = (function (exports) { const id = instance.type.__hmrId; let record = map.get(id); if (!record) { - createRecord(id); + createRecord(id, instance.type); record = map.get(id); } - record.add(instance); + record.instances.add(instance); } function unregisterHMR(instance) { - map.get(instance.type.__hmrId).delete(instance); + map.get(instance.type.__hmrId).instances.delete(instance); } - function createRecord(id) { + function createRecord(id, initialDef) { if (map.has(id)) { return false; } - map.set(id, new Set()); + map.set(id, { + initialDef: normalizeClassComponent(initialDef), + instances: new Set() + }); return true; } function normalizeClassComponent(component) { @@ -1557,7 +1553,9 @@ var Vue = (function (exports) { if (!record) { return; } - [...record].forEach(instance => { + // update initial record (for not-yet-rendered component) + record.initialDef.render = newRender; + [...record.instances].forEach(instance => { if (newRender) { instance.render = newRender; normalizeClassComponent(instance.type).render = newRender; @@ -1574,17 +1572,16 @@ var Vue = (function (exports) { if (!record) return; newComp = normalizeClassComponent(newComp); + // update initial def (for not-yet-rendered components) + updateComponentDef(record.initialDef, newComp); // create a snapshot which avoids the set being mutated during updates - const instances = [...record]; + const instances = [...record.instances]; for (const instance of instances) { const oldComp = normalizeClassComponent(instance.type); if (!hmrDirtyComponents.has(oldComp)) { // 1. Update existing comp definition to match new one - extend(oldComp, newComp); - for (const key in oldComp) { - if (key !== '__file' && !(key in newComp)) { - delete oldComp[key]; - } + if (oldComp !== record.initialDef) { + updateComponentDef(oldComp, newComp); } // 2. mark definition dirty. This forces the renderer to replace the // component on patch. @@ -1630,6 +1627,14 @@ var Vue = (function (exports) { } }); } + function updateComponentDef(oldComp, newComp) { + extend(oldComp, newComp); + for (const key in oldComp) { + if (key !== '__file' && !(key in newComp)) { + delete oldComp[key]; + } + } + } function tryWrap(fn) { return (id, arg) => { try { @@ -1643,14 +1648,53 @@ var Vue = (function (exports) { }; } - function setDevtoolsHook(hook) { + let buffer = []; + let devtoolsNotInstalled = false; + function emit(event, ...args) { + if (exports.devtools) { + exports.devtools.emit(event, ...args); + } + else if (!devtoolsNotInstalled) { + buffer.push({ event, args }); + } + } + function setDevtoolsHook(hook, target) { exports.devtools = hook; + if (exports.devtools) { + exports.devtools.enabled = true; + buffer.forEach(({ event, args }) => exports.devtools.emit(event, ...args)); + buffer = []; + } + else if ( + // handle late devtools injection - only do this if we are in an actual + // browser environment to avoid the timer handle stalling test runner exit + // (#4815) + // eslint-disable-next-line no-restricted-globals + typeof window !== 'undefined' && + !navigator.userAgent.includes('jsdom')) { + const replay = (target.__VUE_DEVTOOLS_HOOK_REPLAY__ = + target.__VUE_DEVTOOLS_HOOK_REPLAY__ || []); + replay.push((newHook) => { + setDevtoolsHook(newHook, target); + }); + // clear buffer after 3s - the user probably doesn't have devtools installed + // at all, and keeping the buffer will cause memory leaks (#4738) + setTimeout(() => { + if (!exports.devtools) { + target.__VUE_DEVTOOLS_HOOK_REPLAY__ = null; + devtoolsNotInstalled = true; + buffer = []; + } + }, 3000); + } + else { + // non-browser env, assume not installed + devtoolsNotInstalled = true; + buffer = []; + } } function devtoolsInitApp(app, version) { - // TODO queue if devtools is undefined - if (!exports.devtools) - return; - exports.devtools.emit("app:init" /* APP_INIT */, app, version, { + emit("app:init" /* APP_INIT */, app, version, { Fragment, Text, Comment, @@ -1658,9 +1702,7 @@ var Vue = (function (exports) { }); } function devtoolsUnmountApp(app) { - if (!exports.devtools) - return; - exports.devtools.emit("app:unmount" /* APP_UNMOUNT */, app); + emit("app:unmount" /* APP_UNMOUNT */, app); } const devtoolsComponentAdded = /*#__PURE__*/ createDevtoolsComponentHook("component:added" /* COMPONENT_ADDED */); const devtoolsComponentUpdated = @@ -1669,356 +1711,21 @@ var Vue = (function (exports) { /*#__PURE__*/ createDevtoolsComponentHook("component:removed" /* COMPONENT_REMOVED */); function createDevtoolsComponentHook(hook) { return (component) => { - if (!exports.devtools) - return; - exports.devtools.emit(hook, component.appContext.app, component.uid, component.parent ? component.parent.uid : undefined, component); + emit(hook, component.appContext.app, component.uid, component.parent ? component.parent.uid : undefined, component); }; } const devtoolsPerfStart = /*#__PURE__*/ createDevtoolsPerformanceHook("perf:start" /* PERFORMANCE_START */); const devtoolsPerfEnd = /*#__PURE__*/ createDevtoolsPerformanceHook("perf:end" /* PERFORMANCE_END */); function createDevtoolsPerformanceHook(hook) { return (component, type, time) => { - if (!exports.devtools) - return; - exports.devtools.emit(hook, component.appContext.app, component.uid, component, type, time); + emit(hook, component.appContext.app, component.uid, component, type, time); }; } function devtoolsComponentEmit(component, event, params) { - if (!exports.devtools) - return; - exports.devtools.emit("component:emit" /* COMPONENT_EMIT */, component.appContext.app, component, event, params); + emit("component:emit" /* COMPONENT_EMIT */, component.appContext.app, component, event, params); } - const deprecationData = { - ["GLOBAL_MOUNT" /* GLOBAL_MOUNT */]: { - message: `The global app bootstrapping API has changed: vm.$mount() and the "el" ` + - `option have been removed. Use createApp(RootComponent).mount() instead.`, - link: `https://v3.vuejs.org/guide/migration/global-api.html#mounting-app-instance` - }, - ["GLOBAL_MOUNT_CONTAINER" /* GLOBAL_MOUNT_CONTAINER */]: { - message: `Vue detected directives on the mount container. ` + - `In Vue 3, the container is no longer considered part of the template ` + - `and will not be processed/replaced.`, - link: `https://v3.vuejs.org/guide/migration/mount-changes.html` - }, - ["GLOBAL_EXTEND" /* GLOBAL_EXTEND */]: { - message: `Vue.extend() has been removed in Vue 3. ` + - `Use defineComponent() instead.`, - link: `https://v3.vuejs.org/api/global-api.html#definecomponent` - }, - ["GLOBAL_PROTOTYPE" /* GLOBAL_PROTOTYPE */]: { - message: `Vue.prototype is no longer available in Vue 3. ` + - `Use app.config.globalProperties instead.`, - link: `https://v3.vuejs.org/guide/migration/global-api.html#vue-prototype-replaced-by-config-globalproperties` - }, - ["GLOBAL_SET" /* GLOBAL_SET */]: { - message: `Vue.set() has been removed as it is no longer needed in Vue 3. ` + - `Simply use native JavaScript mutations.` - }, - ["GLOBAL_DELETE" /* GLOBAL_DELETE */]: { - message: `Vue.delete() has been removed as it is no longer needed in Vue 3. ` + - `Simply use native JavaScript mutations.` - }, - ["GLOBAL_OBSERVABLE" /* GLOBAL_OBSERVABLE */]: { - message: `Vue.observable() has been removed. ` + - `Use \`import { reactive } from "vue"\` from Composition API instead.`, - link: `https://v3.vuejs.org/api/basic-reactivity.html` - }, - ["GLOBAL_PRIVATE_UTIL" /* GLOBAL_PRIVATE_UTIL */]: { - message: `Vue.util has been removed. Please refactor to avoid its usage ` + - `since it was an internal API even in Vue 2.` - }, - ["CONFIG_SILENT" /* CONFIG_SILENT */]: { - message: `config.silent has been removed because it is not good practice to ` + - `intentionally suppress warnings. You can use your browser console's ` + - `filter features to focus on relevant messages.` - }, - ["CONFIG_DEVTOOLS" /* CONFIG_DEVTOOLS */]: { - message: `config.devtools has been removed. To enable devtools for ` + - `production, configure the __VUE_PROD_DEVTOOLS__ compile-time flag.`, - link: `https://github.com/vuejs/vue-next/tree/master/packages/vue#bundler-build-feature-flags` - }, - ["CONFIG_KEY_CODES" /* CONFIG_KEY_CODES */]: { - message: `config.keyCodes has been removed. ` + - `In Vue 3, you can directly use the kebab-case key names as v-on modifiers.`, - link: `https://v3.vuejs.org/guide/migration/keycode-modifiers.html` - }, - ["CONFIG_PRODUCTION_TIP" /* CONFIG_PRODUCTION_TIP */]: { - message: `config.productionTip has been removed.`, - link: `https://v3.vuejs.org/guide/migration/global-api.html#config-productiontip-removed` - }, - ["CONFIG_IGNORED_ELEMENTS" /* CONFIG_IGNORED_ELEMENTS */]: { - message: () => { - let msg = `config.ignoredElements has been removed.`; - if (isRuntimeOnly()) { - msg += ` Pass the "isCustomElement" option to @vue/compiler-dom instead.`; - } - else { - msg += ` Use config.isCustomElement instead.`; - } - return msg; - }, - link: `https://v3.vuejs.org/guide/migration/global-api.html#config-ignoredelements-is-now-config-iscustomelement` - }, - ["CONFIG_WHITESPACE" /* CONFIG_WHITESPACE */]: { - // this warning is only relevant in the full build when using runtime - // compilation, so it's put in the runtime compatConfig list. - message: `Vue 3 compiler's whitespace option will default to "condense" instead of ` + - `"preserve". To suppress this warning, provide an explicit value for ` + - `\`config.compilerOptions.whitespace\`.` - }, - ["CONFIG_OPTION_MERGE_STRATS" /* CONFIG_OPTION_MERGE_STRATS */]: { - message: `config.optionMergeStrategies no longer exposes internal strategies. ` + - `Use custom merge functions instead.` - }, - ["INSTANCE_SET" /* INSTANCE_SET */]: { - message: `vm.$set() has been removed as it is no longer needed in Vue 3. ` + - `Simply use native JavaScript mutations.` - }, - ["INSTANCE_DELETE" /* INSTANCE_DELETE */]: { - message: `vm.$delete() has been removed as it is no longer needed in Vue 3. ` + - `Simply use native JavaScript mutations.` - }, - ["INSTANCE_DESTROY" /* INSTANCE_DESTROY */]: { - message: `vm.$destroy() has been removed. Use app.unmount() instead.`, - link: `https://v3.vuejs.org/api/application-api.html#unmount` - }, - ["INSTANCE_EVENT_EMITTER" /* INSTANCE_EVENT_EMITTER */]: { - message: `vm.$on/$once/$off() have been removed. ` + - `Use an external event emitter library instead.`, - link: `https://v3.vuejs.org/guide/migration/events-api.html` - }, - ["INSTANCE_EVENT_HOOKS" /* INSTANCE_EVENT_HOOKS */]: { - message: event => `"${event}" lifecycle events are no longer supported. From templates, ` + - `use the "vnode" prefix instead of "hook:". For example, @${event} ` + - `should be changed to @vnode-${event.slice(5)}. ` + - `From JavaScript, use Composition API to dynamically register lifecycle ` + - `hooks.`, - link: `https://v3.vuejs.org/guide/migration/vnode-lifecycle-events.html` - }, - ["INSTANCE_CHILDREN" /* INSTANCE_CHILDREN */]: { - message: `vm.$children has been removed. Consider refactoring your logic ` + - `to avoid relying on direct access to child components.`, - link: `https://v3.vuejs.org/guide/migration/children.html` - }, - ["INSTANCE_LISTENERS" /* INSTANCE_LISTENERS */]: { - message: `vm.$listeners has been removed. In Vue 3, parent v-on listeners are ` + - `included in vm.$attrs and it is no longer necessary to separately use ` + - `v-on="$listeners" if you are already using v-bind="$attrs". ` + - `(Note: the Vue 3 behavior only applies if this compat config is disabled)`, - link: `https://v3.vuejs.org/guide/migration/listeners-removed.html` - }, - ["INSTANCE_SCOPED_SLOTS" /* INSTANCE_SCOPED_SLOTS */]: { - message: `vm.$scopedSlots has been removed. Use vm.$slots instead.`, - link: `https://v3.vuejs.org/guide/migration/slots-unification.html` - }, - ["INSTANCE_ATTRS_CLASS_STYLE" /* INSTANCE_ATTRS_CLASS_STYLE */]: { - message: componentName => `Component <${componentName || 'Anonymous'}> has \`inheritAttrs: false\` but is ` + - `relying on class/style fallthrough from parent. In Vue 3, class/style ` + - `are now included in $attrs and will no longer fallthrough when ` + - `inheritAttrs is false. If you are already using v-bind="$attrs" on ` + - `component root it should render the same end result. ` + - `If you are binding $attrs to a non-root element and expecting ` + - `class/style to fallthrough on root, you will need to now manually bind ` + - `them on root via :class="$attrs.class".`, - link: `https://v3.vuejs.org/guide/migration/attrs-includes-class-style.html` - }, - ["OPTIONS_DATA_FN" /* OPTIONS_DATA_FN */]: { - message: `The "data" option can no longer be a plain object. ` + - `Always use a function.`, - link: `https://v3.vuejs.org/guide/migration/data-option.html` - }, - ["OPTIONS_DATA_MERGE" /* OPTIONS_DATA_MERGE */]: { - message: (key) => `Detected conflicting key "${key}" when merging data option values. ` + - `In Vue 3, data keys are merged shallowly and will override one another.`, - link: `https://v3.vuejs.org/guide/migration/data-option.html#mixin-merge-behavior-change` - }, - ["OPTIONS_BEFORE_DESTROY" /* OPTIONS_BEFORE_DESTROY */]: { - message: `\`beforeDestroy\` has been renamed to \`beforeUnmount\`.` - }, - ["OPTIONS_DESTROYED" /* OPTIONS_DESTROYED */]: { - message: `\`destroyed\` has been renamed to \`unmounted\`.` - }, - ["WATCH_ARRAY" /* WATCH_ARRAY */]: { - message: `"watch" option or vm.$watch on an array value will no longer ` + - `trigger on array mutation unless the "deep" option is specified. ` + - `If current usage is intended, you can disable the compat behavior and ` + - `suppress this warning with:` + - `\n\n configureCompat({ ${"WATCH_ARRAY" /* WATCH_ARRAY */}: false })\n`, - link: `https://v3.vuejs.org/guide/migration/watch.html` - }, - ["PROPS_DEFAULT_THIS" /* PROPS_DEFAULT_THIS */]: { - message: (key) => `props default value function no longer has access to "this". The compat ` + - `build only offers access to this.$options.` + - `(found in prop "${key}")`, - link: `https://v3.vuejs.org/guide/migration/props-default-this.html` - }, - ["CUSTOM_DIR" /* CUSTOM_DIR */]: { - message: (legacyHook, newHook) => `Custom directive hook "${legacyHook}" has been removed. ` + - `Use "${newHook}" instead.`, - link: `https://v3.vuejs.org/guide/migration/custom-directives.html` - }, - ["V_FOR_REF" /* V_FOR_REF */]: { - message: `Ref usage on v-for no longer creates array ref values in Vue 3. ` + - `Consider using function refs or refactor to avoid ref usage altogether.`, - link: `https://v3.vuejs.org/guide/migration/array-refs.html` - }, - ["V_ON_KEYCODE_MODIFIER" /* V_ON_KEYCODE_MODIFIER */]: { - message: `Using keyCode as v-on modifier is no longer supported. ` + - `Use kebab-case key name modifiers instead.`, - link: `https://v3.vuejs.org/guide/migration/keycode-modifiers.html` - }, - ["ATTR_FALSE_VALUE" /* ATTR_FALSE_VALUE */]: { - message: (name) => `Attribute "${name}" with v-bind value \`false\` will render ` + - `${name}="false" instead of removing it in Vue 3. To remove the attribute, ` + - `use \`null\` or \`undefined\` instead. If the usage is intended, ` + - `you can disable the compat behavior and suppress this warning with:` + - `\n\n configureCompat({ ${"ATTR_FALSE_VALUE" /* ATTR_FALSE_VALUE */}: false })\n`, - link: `https://v3.vuejs.org/guide/migration/attribute-coercion.html` - }, - ["ATTR_ENUMERATED_COERCION" /* ATTR_ENUMERATED_COERCION */]: { - message: (name, value, coerced) => `Enumerated attribute "${name}" with v-bind value \`${value}\` will ` + - `${value === null ? `be removed` : `render the value as-is`} instead of coercing the value to "${coerced}" in Vue 3. ` + - `Always use explicit "true" or "false" values for enumerated attributes. ` + - `If the usage is intended, ` + - `you can disable the compat behavior and suppress this warning with:` + - `\n\n configureCompat({ ${"ATTR_ENUMERATED_COERCION" /* ATTR_ENUMERATED_COERCION */}: false })\n`, - link: `https://v3.vuejs.org/guide/migration/attribute-coercion.html` - }, - ["TRANSITION_CLASSES" /* TRANSITION_CLASSES */]: { - message: `` // this feature cannot be runtime-detected - }, - ["TRANSITION_GROUP_ROOT" /* TRANSITION_GROUP_ROOT */]: { - message: `