Merge branch 'main' into patch-1

Author: joaop221

data/migratedPages.yml

@@ -173,7 +173,7 @@ Debugging_network_requests_in_the_Moodle_App:
 - filePath: "/general/app/development/network-debug.md"
   slug: "/general/app/development/network-debug"
 Deprecation:
-- filePath: "/general/development/policies/deprecation.md"
+- filePath: "/general/development/policies/deprecation/index.md"
   slug: "/general/development/policies/deprecation"
 Designing_usable_forms:
 - filePath: "/general/development/policies/designing-usable-forms.md"
@@ -1291,8 +1291,8 @@ Moodle_App_4.0.1_release_notes:
 - filePath: "/general/app_releases/v4/v4.0.1.md"
   slug: "/general/app_releases/v4/v4.0.1"
 Moodle_App_Accessibility:
-- filePath: "/general/app/accessibility.md"
-  slug: "/general/app/accessibility"
+- filePath: "/general/app/development/accessibility.md"
+  slug: "/general/app/development/accessibility"
 Moodle_App_Coding_Style:
 - filePath: "/general/development/policies/codingstyle-moodleapp.md"
   slug: "/general/development/policies/codingstyle-moodleapp"

data/moodle-contributors.txt

@@ -115,6 +115,7 @@ Baxter
 Bayler
 Beedell
 Belgium
+Bellen
 Bence
 Benjamin
 Bennett
@@ -168,6 +169,7 @@ Cameron
 Campbell
 Candilio
 Carlos
+Carrera
 Carrick
 Carrier
 Carrillo
@@ -971,6 +973,7 @@ Shamiso.Jaravaza
 Shane
 Sharp
 Shashikant
+Shehata
 Sheremeta
 Shintaro
 Shwab
@@ -1381,6 +1384,7 @@ papillon326
 papita
 patrickslee
 pau.ferrer-ocana
+pedrojordao
 petcheverry
 peterbulmer
 phoenixfr

data/versions.json

@@ -510,7 +510,6 @@
                 },
                 {
                     "name": "3.9.24",
-                    "releaseNoteUrl": false,
                     "releaseDate": "9 October 2023",
                     "version": 2020061524
                 }

general/app/development/development-guide.md

@@ -105,7 +105,7 @@ The `core.module.ts` file defines a module that imports all the core providers a
 
 The `shared.module.ts` file defines a [Shared Module](https://angular.io/guide/module-types#shared-ngmodules) that exposes core declarables (components, directives and pipes). When other modules use any of these, it's preferable to import this module instead of individual declarable modules separately.
 
-There is also a `constants.ts` file with global read-only values.
+There is also a `constants.ts` file which should follow the conventions for [constants files](#constants-files).
 
 #### core/initializers/
 
@@ -196,6 +196,7 @@ In addition to these files, feature folders may contain the following:
 - `components/` — Same as [core/components/](#corecomponents) (with the *core-{feature-name}-* namespace).
 - `directives/` and `pipes/` — Same as [core/directives/ and core/pipes/](#coredirectives-and-corepipes).
 - `lang.json` — See [Language files](#language-files).
+- `constants.ts` — See [Constants files](#constants-files).
 - `services/` — Same as [core/services/](#coreservices).
 - `pages/` — Page folders have the same structure as [core/components/](#corecomponents), but in addition they can declare modules if a page component is to be used in more than one module. Also, page components will declare their selectors starting with `page-`.
 
@@ -253,12 +254,20 @@ If a folder contains more than one type of TypeScript file, the type of file sho
 
 ### Language files
 
-All feature and addon folders can contain a lang.json file, as well as the `core/` folder. The JSON file contains all translatable string keys with the current english text. During compilation, those files will be merged into one single file on `assets/lang/en.json` that will contain the cooked string keys (every key of those files will be prepended with the module prefix).
+All feature and addon folders can contain a `lang.json` file, as well as the `core/` folder. The JSON file contains all translatable string keys with the current english text. During compilation, those files will be merged into one single file on `assets/lang/en.json` that will contain the cooked string keys (every key of those files will be prepended with the module prefix).
 
 An automatic process will create the rest of the language files on the `assets/lang/` folder based on the Moodle translation platform: [AMOS](https://lang.moodle.org/).
 
 In order to match existing Moodle language strings with the app strings the app contains a file on the scripts folder called `langindex.json`. This file contains an indexed array with the cooked string keys of the app, the value of every item is the module (file name) where to find the string in AMOS. If the value contains a slash '/' the text before the slash will correspond to the module (file name) and the text after will correspond to the string key on that file. If it does not contain a slash, the string key will be the last part of the cooked string key (splitting using dots .).
 
+### Constants files
+
+All exported constants should be declared within a `constants.ts` file. The term "constant" in TypeScript can be somewhat misleading, given that it is often used with the `const` keyword. What we mean with "constants" is simple read-only values. Most of the time, these will be primitive values (string, number, boolean, etc.) or simple objects.
+
+This may seem cumbersome at first, but it's very important in order to optimize [Code Splitting](https://webpack.js.org/guides/code-splitting/). Which can seriously impact performance. Given the size of the codebase, including a file in a bundle that doesn't need it can result in a cascade effect that bloats chunk sizes significantly. And constants are usually used outside of a module (for example, using route segments or unique identifiers).
+
+Additionally, because it's very likely that the content of these files ends up in the initial bundle of the application, they should seldom import anything (possibly with the exception of other constants).
+
 ### Test files
 
 Tests are found anywhere inside the `src/` folder, and they will be run as long as they end with *.test.ts*. As a general rule, they are placed in a folder next to the module responsible for the code being tested. And they mirror the folder structure.

general/app/development/link-handling/app-links.md

@@ -10,8 +10,10 @@ tags:
 
 When a user presses a link in the Moodle app, the behaviour changes depending on whether the URL is supported by the app or not:
 
-- If the URL belongs to the same site and it's supported by the app, then the app will try to open the corresponding page inside the app. For example if the user presses a link to an assignment, then the assignment will be opened inside the app if possible.
-- If it's a URL pointing to an external site or it's a URL not supported by the app then it will be opened in a browser. For example admin settings aren't supported by the app, so clicking a link to an admin settings page will open the page in browser.
+- If the URL belongs to the same site and it's supported by the app, then the app will try to open the corresponding page. For example if the user presses a link to an assignment, then the assignment will be opened inside the app rather than opening a browser.
+- If it's a URL pointing to an external site or it's a URL not supported by the app, then it will be opened in an external browser. This can also be configured to [open in an embedded browser](#opening-links-in-an-embedded-browser). For example admin settings aren't supported by the app, so clicking a link to an admin settings page will open the page in an external browser.
+- If it's a URL pointing to a local file it will be opened with an external app in Android, and an embedded viewer in iOS. For example opening a PDF within a SCORM package would open a PDF reader in Android or and embedded PDF viewer in iOS.
+- If the link is inside an iframe (and is not pointing to a local file), it will be opened within the same iframe. This behaviour can be changed by setting the link's `target` attribute to anything other than `_self`, in which case the URL will be opened in an external browser. For example, clicking a link with a `target="_blank"` attribute would open the URL in an external browser.
 
 ## Extending the list of supported URLs
 

general/app/development/plugins-development-guide/index.md

@@ -597,6 +597,17 @@ In the previous section, we learned about some of the existing options for handl
     - Any other value — Your block will immediately call the method specified in `mobile.php` and it will use the template to render the block.
 - `fallback` (optional) — This option allows you to specify a block to use in the app instead of your block. For example, you can make the app display the "My overview" block instead of your block in the app by setting `'fallback' => 'myoverview'`. The fallback will only be used if you don't specify a `method` and the `type` is different to `'title'` or `'prerendered'`. Supported from the 3.9.0 version of the app.
 
+### Options only for CoreEnrolDelegate
+
+- `enrolmentAction` (optional): The type of action done by the enrolment plugin. Defaults to 'browser'. Possible values:
+  - `browser` — When the user clicks to enrol, open a browser to perform the enrol in the browser. It doesn't require any JavaScript to work in the app.
+  - `self` — The user can self enrol in the app. Requires implementing the 'enrol' function in your JavaScript code. Also, your PHP class extending `enrol_plugin` should return some data instead of null in the `get_enrol_info` function, otherwise it won't work in the app.
+  - `guest` — Allows the user to enter the course as guest in the app. Requires implementing the 'canAccess' and 'validateAccess' functions in your JavaScript code. Also, your PHP class extending `enrol_plugin` should return some data instead of null in the `get_enrol_info` function, otherwise it won't work in the app.
+- `infoIcons` (optional) — Icons related to the enrolment to display next to the course. If the icons need to be calculated dynamically based on the course you need to implement the function 'getInfoIcons' in your JavaScript code. Properties for each icon:
+  - `icon` (required) — The icon name. E.g. 'fas-credit-card'.
+  - `label` (required) — The label of the icon (for accessibility).
+  - `className` (optional) — A CSS class to add to the icon element.
+
 ## Delegates
 
 Delegates can be classified by type of plugin. For more info about type of plugins, please see the [Types of plugins](#types-of-plugins) section.
@@ -678,6 +689,7 @@ These delegates require JavaScript to be supported. See [Initialisation](#initia
 - `CoreFileUploaderDelegate`
 - `CorePluginFileDelegate`
 - `CoreFilterDelegate`
+- `CoreEnrolDelegate` (added in 4.3 version of the app)
 
 ## Available components and directives
 
@@ -1631,6 +1643,59 @@ class AddonSingleActivityFormatHandler {
 this.CoreCourseFormatDelegate.registerHandler(new AddonSingleActivityFormatHandler());
 ```
 
+##### Self enrol plugin
+
+The `CoreEnrolDelegate` handler allows you to support enrolment plugins in the app. This example will show how to support a self enrol plugin, you can find an example of each type of plugin in the issue [MOBILE-4323](https://tracker.moodle.org/browse/MOBILE-4323).
+
+Here's an example on how to create a prefetch handler using the JS returned by the main method:
+
+```javascript
+const getEnrolmentInfo = (id) => {
+    // Get enrolment info for the enrol instance.
+    // Used internally, you can use any name, parameters and return data in here.
+};
+
+const selfEnrol = (method, info) => {
+    // Self enrol the user in the course.
+    // Used internally, you can use any name, parameters and return data in here.
+};
+
+var result = {
+    getInfoIcons: (courseId) => {
+        return this.CoreEnrolService.getSupportedCourseEnrolmentMethods(courseId, 'selftest').then(enrolments => {
+            if (!enrolments.length) {
+                return [];
+            }
+
+            // Since this code is for testing purposes just use the first one.
+            return getEnrolmentInfo(enrolments[0].id).then(info => {
+                if (!info.enrolpassword) {
+                    return [{
+                        label: 'plugin.enrol_selftest.pluginname',
+                        icon: 'fas-right-to-bracket',
+                    }];
+                } else {
+                    return [{
+                        label: 'plugin.enrol_selftest.pluginname',
+                        icon: 'fas-key',
+                    }];
+                }
+            });
+        });
+    },
+    enrol: (method) => {
+        return getEnrolmentInfo(method.id).then(info => {
+            return selfEnrol(method, info);
+        });
+    },
+    invalidate: (method) => {
+        // Invalidate WS data.
+    },
+};
+
+result;
+```
+
 ### Using the JavaScript API
 
 The JavaScript API is only supported by the delegates specified in the [Templates downloaded on login and rendered using JS data](#templates-downloaded-on-login-and-rendered-using-js-data) section. This API allows you to override any of the functions of the default handler.

general/app/development/setup/troubleshooting.md

@@ -35,9 +35,7 @@ To get more debug output from npm commands, see [the available configuration fla
 
 ## I can't change the language
 
-If you're getting a network error for a url like `http://localhost:8100/assets/lang/es.json`, this probably means that you haven't installed the language packs.
-
-Currently, you can install them in your machine running the `scripts/update_lang.sh` script, but it may not work in your system if you don't have php installed. For future improvements, you can subscribe to [MOBILE-3864](https://tracker.moodle.org/browse/MOBILE-3864).
+If you're getting a network error for a url like `http://localhost:8100/assets/lang/es.json`, this probably means that you haven't installed the language packs. You can install them with `npm run lang:update-langpacks`.
 
 ## Error: `libsass` bindings not found. Try reinstalling node-sass?
 

general/app/development/testing/acceptance-testing.md

@@ -286,7 +286,15 @@ Behat tests can relate to particular versions of the mobile app. For these situa
 
 You can use two-digit or three-digit version numbers. For example, you could use `@app_from4.0` or `@app_upto3.9.5`.
 
-After changing the app version used for testing, make sure you re-run Behat init. It is the initialisation process that stores which version of the app you're using.
+Keep in mind that these tags will only take effect after using the `I enter the app` step, so it won't be effective for skipping steps in your Background blocks. If you need to skip these as well, you can do it using the following step:
+
+```gherkin
+  Background:
+    Given the Moodle site is compatible with this feature
+    And the following "courses" exist:
+```
+
+Also, after changing the app version used for testing, make sure you re-run Behat init. It is the initialisation process that stores which version of the app you're using.
 
 ### Testing against multiple app versions
 

general/app/overview.md

@@ -65,7 +65,7 @@ When the application connects with a site, it will fetch information about which
 
 ## Platform Support
 
-The Moodle App only works with Moodle sites running version 3.1 or newer.
+The Moodle App only works with Moodle sites running version 3.5 or newer.
 
 The minimum platforms supported by the application are Android 5.1 (with Webview 61 or higher) and iOS 11.