Merge branch 'main' into copilot/fix-569

Author: ascott18

.github/copilot-instructions.md

@@ -0,0 +1,50 @@
+# Coalesce Framework Development Instructions
+
+Always follow these instructions first and fallback to additional search and context gathering only when the information here is incomplete or found to be in error.
+
+## Project Overview
+
+Coalesce is a framework for rapid development of ASP.NET Core + Vue.js web applications. It generates DTOs, API controllers, and TypeScript from Entity Framework Core models and other C# code.
+
+## Prerequisites & Dependencies
+
+The required tools and dependencies are automatically installed via the GitHub Actions workflow at `.github/workflows/copilot-setup-steps.yml`.
+
+## Instructions
+
+- Format PR titles with Semantic Commits. The work item number should follow the colon after the commit type like `feat: #12345 added ...`
+- Always update the documentation when making changes or adding features that will affect developers who use Coalesce.
+- Always add an entry to CHANGELOG.md when adding new features or fixing non-trivial bugs.
+- Avoid making breaking changes if not necessary. A less obvious example of a breaking change would be changing an existing CSS class name.
+- Consider adding or updating example files in `playground\Coalesce.Web.Vue3\src\examples` when making changes to coalesce-vue-vuetify.
+
+## Validation Checklist
+
+After making changes, ALWAYS run this validation sequence:
+
+1. **Build verification**:
+   From the repo root:
+
+```bash
+npm ci
+dotnet build
+cd src/coalesce-vue && npm run build
+cd ../coalesce-vue-vuetify3 && npm run build
+```
+
+2. **Test verification**:
+   From the repo root:
+
+```bash
+dotnet test
+cd src/coalesce-vue && npm run test
+cd ../coalesce-vue-vuetify3 && npm run test
+```
+
+3. **Template verification**:
+   If you make changes to the template in the `templates` directory, validate the changes by running `TestLocal.ps1 -- "--FeatureOne --FeatureTwo"` where the FeatureOne, FeatureTwo parameters are replaced with each flag that might affect the changes you made. Run it multiple times if there are different combinations of feature flags that might interact in different ways. The flags are the variables checked by the `#if` in the template code.
+
+4. **Documentation verification**:
+   If the documentation was updated, run `npm run build` in the docs folder. You can expect the link checks to fail - you do not have access to the internet to validate the links.
+
+REMEMBER: NEVER CANCEL long-running build operations.

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,50 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      contents: read
+
+    timeout-minutes: 30
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup dotnet
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            8.0.x
+            9.0.x
+
+      - name: Install JavaScript dependencies
+        run: npm ci
+
+      - name: Restore .NET packages
+        run: dotnet restore
+
+      - name: Build solution
+        run: dotnet build --no-restore --configuration Release
+
+      - name: Build coalesce-vue-vuetify3
+        working-directory: src/coalesce-vue-vuetify3
+        run: |
+          npm run build-local-deps
+          npm run build

.github/workflows/part-build.yml

@@ -139,14 +139,38 @@ jobs:
       - run: npm ci
         working-directory: ${{ github.workspace }}
 
-      - run: npm run build
+      - name: Build docs (without linkcheck)
+        run: npm run build-only
 
       - name: Upload Artifact
         uses: actions/upload-artifact@v4
         with:
           name: docs
           path: docs/.vitepress/dist/Coalesce
 
+  linkcheck-docs:
+    runs-on: ubuntu-latest
+    needs: build-docs
+    defaults:
+      run:
+        shell: bash
+        working-directory: docs
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: npm ci
+        # working-directory: ${{ github.workspace }}
+
+      - name: Download built docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: docs/.vitepress/dist/Coalesce
+
+      - name: Run linkcheck
+        run: npm run linkcheck
+
   validate-template:
     runs-on: ubuntu-latest
     name: "test template: ${{matrix.testCase}}"

CHANGELOG.md

@@ -22,13 +22,15 @@
 - `ListViewModel.$orderByToggle()` method added to cycle through ascending, descending, and no ordering for a field.
 - Custom methods now support descriptions via `DescriptionAttribute`. These are displayed in the admin pages. 
 - Added `FileTypeAttribute` to control allowed file types for custom method file parameters.
+- Added `ClientCacheDurationSeconds` property to `ExecuteAttribute` to customize client-side cache duration for GET custom methods with `VaryByProperty`.
 - `c-admin-display`: Binary values now render as links that will download the value as a file, instead of only showing the length in bytes.
 - `c-datetime-picker`: Added prop `showTodayButton`
 - `c-input`: Added a `filter` prop for enum inputs to restrict the values available for selection.
 - `c-select`: When bound to a `ViewModel` or `ViewModelCollection`, selected items are converted to `ViewModel` instances before being emitted so that event handlers will receive the final object instance, rather than the intermediate plain model instance.
 - `c-select`: Now supports binding to a non-many-to-many collection navigation property. Selecting an item will populate the foreign key of the dependent item, and deselecting an item will clear the foreign key. This mechanism is only available when using c-select directly - it is not delegated by c-input.
 - `c-select`: The `create` prop now supports a `position` property to control whether the create item appears at the start ('start', default) or end ('end') of the dropdown list.
 - `c-select-many-to-many`: The `itemTitle` prop now receives the existing selected middle entity instance, if there is one.
+- `c-loader-status`: Added `show-success` prop and flag to display success messages when operations complete successfully.
 
 ## Fixes
 - Fix error in codegen when using JS reserved keywords or C# contextual keywords as parameter names.

docs/check-links.mjs

@@ -23,7 +23,7 @@ let server;
 try {
   // Start static file server
   server = createServer((req, res) =>
-    handler(req, res, { public: ".vitepress/dist" })
+    handler(req, res, { public: ".vitepress/dist" }),
   );
 
   await new Promise((resolve) => server.listen(8087, resolve));
@@ -32,7 +32,12 @@ try {
   await waitOn({ resources: ["http://localhost:8087"], timeout: 30000 });
 
   // Run linkcheck
-  await run("npm", ["run", "linkcheck"]);
+  await run("linkcheck", [
+    "localhost:8087/Coalesce",
+    "-e",
+    "--skip-file",
+    "./.vitepress/linkcheck-skip-file.txt",
+  ]);
 
   process.exit(0);
 } catch (err) {

docs/cspell.json

@@ -3,13 +3,15 @@
     "language": "en",
     "words": [
         "appsettings",
+        "ASPNETCORE",
         "autosave",
         "autosaving",
         "Axios",
         "bootstrap-datetimepicker",
         "Coalesce",
         "coalesceko",
         "coalescevue",
+        "discoverability",
         "dontSerialize",
         "dtos",
         "EF",
@@ -18,11 +20,12 @@
         "instanceof",
         "IntelliTect",
         "mkdir",
+        "msword",
         "nameof",
-        "overridable",
-        "discoverability",
         "netcoreapp",
         "netstandard",
+        "officedocument",
+        "openxmlformats",
         "overridable",
         "POCOs",
         "queryable",
@@ -31,6 +34,8 @@
         "readonly",
         "snapshotted",
         "Stampable",
+        "swashbuckle",
+        "Swashbuckle",
         "TPCT",
         "treeshaken",
         "typeof",
@@ -41,9 +46,9 @@
         "Vitest",
         "Vuetify",
         "webp",
-        "wwwroot",
-        "Swashbuckle",
-        "swashbuckle"
+        "westus",
+        "wordprocessingml",
+        "wwwroot"
     ],
     "ignorePaths": [
         "node_modules"

docs/package.json

@@ -8,8 +8,9 @@
   "license": "Apache-2.0",
   "scripts": {
     "dev": "vitepress dev",
-    "linkcheck": "linkcheck localhost:8087/Coalesce -e --skip-file ./.vitepress/linkcheck-skip-file.txt",
-    "build": "cspell \"**/*.md\" && vitepress build --outDir .vitepress/dist/Coalesce && node check-links.mjs"
+    "build-only": "cspell \"**/*.md\" && vitepress build --outDir .vitepress/dist/Coalesce",
+    "linkcheck": "node check-links.mjs",
+    "build": "npm run build-only && npm run linkcheck"
   },
   "dependencies": {
     "shiki": "1.4.0"
@@ -18,6 +19,7 @@
     "gray-matter": "^4.0.3",
     "linkcheck-bin": "file:linkcheck-bin-3.0.0-1.fix-issue-56.tgz",
     "serve-handler": "^6.1.6",
-    "vitepress": "2.0.0-alpha.5"
+    "vitepress": "2.0.0-alpha.5",
+    "wait-on": "^8.0.4"
   }
 }

docs/stacks/vue/coalesce-vue-vuetify/components/c-loader-status.md

@@ -46,6 +46,13 @@ Wrap a save/submit button:
 </c-loader-status>
 ```
 
+Show success alerts when operations complete successfully:
+``` vue-html
+<c-loader-status :loaders="person.$save" show-success>
+    <button> Save </button>
+</c-loader-status>
+```
+
 Hides the table before the first load has completed, or if loading the list encountered an error. Don't show the progress bar after we've already loaded the list for the first time (useful for loads that occur without user interaction, e.g. `setInterval`):
 
 ``` vue-html
@@ -119,13 +126,14 @@ no-error-content?: boolean;
 no-initial-content?: boolean;
 no-progress?: boolean;
 no-initial-progress?: boolean;
-no-secondary-progress?: boolean;" lang="ts" id="flags-props" />
+no-secondary-progress?: boolean;
+show-success?: boolean;" lang="ts" id="flags-props" />
 
 Component level [flags](#flags) options that control behavior when the simple form of `loaders` (single instance or array) is used, as well as provide baseline defaults that can be overridden by the advanced form of `loaders` (object map) .
 
 ## Flags
 
-The available flags are as follows, all of which default to `true`. In the object literal syntax for `loaders`, the `no-` prefix may be omitted to set the flag to `true`.
+The available flags are as follows, all of which default to `true` except for `show-success` which defaults to `false`. In the object literal syntax for `loaders`, the `no-` prefix may be omitted to set the flag to `true`.
 
 | <div style="width:160px">Flag</div> | Description |
 | - | - |
@@ -135,6 +143,7 @@ The available flags are as follows, all of which default to `true`. In the objec
 | `no-progress` | Master toggle for whether the progress indicator is shown in any scenario. |
 | `no-initial-progress` | Controls whether the progress indicator is shown when an API Caller is loading for the very first time (i.e. when  `caller.wasSuccessful === null`). |
 | `no-secondary-progress` | Controls whether the progress indicator is shown when an API Caller is loading any time after its first invocation (i.e. when  `caller.wasSuccessful !== null`). |
+| `show-success` | Controls whether success alerts are shown when API calls complete successfully (i.e. when `caller.wasSuccessful === true`). |
 
 ## Slots
 

docs/stacks/vue/getting-started.md

@@ -75,7 +75,7 @@ If any of the options you chose above require external integrations, you'll need
 
 ### AppHost Project
 
-The AppHost project is a [.NET Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview) dev-time orchestration project. It is recommended you set this as your startup project when developing, although this is not strictly required if your project only has SQL Server as its sole dependency. If you're not familiar with .NET Aspire, you're strongly encouraged to read through its [overview documentation](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview#dev-time-orchestration) and learn about the features of the [Aspire dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/explore).
+The AppHost project is a [.NET Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview) dev-time orchestration project. It is recommended you set this as your startup project when developing, although this is not strictly required if your project only has SQL Server as its sole dependency. If you're not familiar with .NET Aspire, you're strongly encouraged to read through its [overview documentation](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview) and learn about the features of the [Aspire dashboard](https://learn.microsoft.com/en-us/dotnet/aspire/fundamentals/dashboard/explore).
 
 ### Data Project
 

docs/topics/audit-logging.md

@@ -117,9 +117,9 @@ public class AppDbContext : DbContext, IAuditLogDbContext<AuditLog>
 
 ### Exclusions & Formatting
 
-Coalesce's audit logging is built on top of [Entity Framework Plus](https://entityframework-plus.net/ef-core-audit) and can be configured using all of its [configuration](https://entityframework-plus.net/ef-core-audit#scenarios), including [includes/excludes](https://entityframework-plus.net/ef-core-audit-exclude-include-entity) and [custom property formatting](https://entityframework-plus.net/ef-core-audit-format-value).
+Coalesce's audit logging uses Entity Framework's change tracking capabilities to automatically detect and record changes to your entities. It intercepts the `SaveChanges` operation to capture entity state changes and property modifications before they're committed to the database.
 
-Coalesce will not use EF Plus's `AuditManager.DefaultConfiguration` global singleton instance. You must use Coalesce's configuration extensions which allow for more targeted configuration per context that does not rely on a global static singleton. For example:
+You can configure which entities and properties to include or exclude from auditing, as well as customize how property values are formatted in the audit logs. Coalesce's configuration extensions allow for targeted configuration per context without relying on global static singletons. For example:
 
 ``` c#
 public class AppDbContext : DbContext, IAuditLogDbContext<AuditLog>