[WC-2793] Calendar release

docs/requirements/widget-to-module.md

@@ -0,0 +1,149 @@
+# Converting a Pluggable Widget into a Mendix **Module**
+
+This guide documents a repeatable workflow for converting any pluggable widget package (for example, **@mendix/calendar-web**) into a Mendix **Module** package (for example, **@mendix/calendar**). The resulting module bundles pages, domain model, microflows and the widget itself. The steps below align with the automation scripts located in `automation/utils` within this repository.
+
+---
+
+## 1. Terminology
+
+| Term                | Purpose                                                                                                                      |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| _Widget package_    | `.mpk` produced by Rollup in `packages/pluggableWidgets/<name>-web`; contains only `<clientModule>` (JavaScript, XML, SCSS). |
+| _Module package_    | `.mpk` exported by Studio Pro; contains `<module>` (pages, microflows, domain model **plus** embedded widget mpk).           |
+| **Authoring app**   | Your working project where you design the pages/microflows for the module.                                                   |
+| **Host / test app** | A minimal blank project used by CI to (re)export the module; committed to `mendix/testProjects` repo.                        |
+
+---
+
+## 2. Prerequisites
+
+- Node + `pnpm install` executed in the mono-repo.
+- **@mendix/_widget_-web** already builds (`pnpm run build`).
+- GitHub Personal-Access Token saved as secret `GH_PAT` for release workflow.
+
+---
+
+## 3. Create / Export the Module in Studio Pro
+
+1. **Authoring app**: make sure everything lives inside one module (e.g. _Calendar_).
+2. Right–click that module → _Export module package…_ → save `Calendar.mpk`.
+   _This file contains pages, flows, entities and the widget placeholder._
+
+---
+
+## 4. Prepare the Host Test Project
+
+1. Start a **Blank App** in Studio Pro (or `mx create-project`).
+2. _App → Import module package…_ and select the `Calendar.mpk` from step 3.
+3. Optional: add a navigation item to a Calendar page so the app runs out-of-box.
+4. Close Studio Pro.
+5. In terminal:
+    ```bash
+    cd <project-folder>
+    git init
+    git switch -c calendar-web              # branch must match package.json
+    git remote add origin https://github.com/mendix/testProjects.git
+    echo "/deployment/\n/theme-cache/" > .gitignore
+    git add .
+    git commit -m "Initial Calendar host project"
+    git push -u origin calendar-web         # or pull –rebase first if branch exists
+    ```
+
+---
+
+## 5. Scaffold the Module Package in the Mono-repo
+
+```
+packages/modules/calendar/
+ ├─ package.json          ← see template below
+ ├─ CHANGELOG.md
+ ├─ LICENSE               ← Apache 2.0 copy
+ ├─ .prettierrc.js
+ └─ scripts/
+     ├─ build.ts
+     ├─ push-update.ts
+     ├─ release.ts
+     └─ tsconfig.json
+```
+
+### `package.json` highlights
+
+```jsonc
+{
+    "name": "@mendix/calendar",
+    "mxpackage": {
+        "type": "module",
+        "name": "Calendar",
+        "mpkName": "Calendar.mpk",
+        "dependencies": ["@mendix/calendar-web"]
+    },
+    "moduleFolderNameInModeler": "calendar", // themesource/javascriptsource
+    "testProject": {
+        "githubUrl": "https://github.com/mendix/testProjects",
+        "branchName": "calendar-web"
+    },
+    "scripts": {
+        "build:module": "ts-node --project scripts/tsconfig.json scripts/build.ts",
+        "release:module": "ts-node --project scripts/tsconfig.json scripts/release.ts"
+    }
+}
+```
+
+Scripts are copied from `packages/modules/file-uploader/scripts/`.
+
+---
+
+## 6. Local Verification
+
+```bash
+# build the widget first
+pnpm --filter @mendix/calendar-web run build
+
+#   Option A: point to a running Studio Pro project
+export MX_PROJECT_PATH="$HOME/Mendix/CalendarHost"
+
+#   Option B: rely on tests/testProject folder
+# (create it or let cloneTestProject do it in release script)
+
+pnpm --filter @mendix/calendar run build:module
+```
+
+The command clones (or uses `MX_PROJECT_PATH`) and copies `com.mendix.widget.web.calendar.mpk` into `widgets/`. Open the project in Studio Pro and run.
+
+---
+
+## 7. Produce the Distributable MPK
+
+```bash
+pnpm --filter @mendix/calendar run release:module
+```
+
+Pipeline steps (see `automation/utils/src/steps.ts`):
+
+1. `removeDist`  clean old output
+2. `cloneTestProject` clone branch `calendar-web`
+3. `writeModuleVersion` / `copyModuleLicense`
+4. `copyWidgetsToProject` add fresh widget mpk
+5. `createModuleMpk` export Calendar module via _mxbuild_
+6. `addWidgetsToMpk` embed widget MPK in module MPK
+7. `moveModuleToDist` place under `dist/<version>/Calendar.mpk`
+
+Upload the resulting MPK to the Mendix Marketplace.
+
+---
+
+## 8. CI / GitHub Actions
+
+• `.github/workflows/CreateGitHubRelease.yml` uses `${{ secrets.GH_PAT }}` to create a release and attach the MPK asset. Set that PAT in _Repo → Settings → Secrets → Actions_.
+
+---
+
+## 9. Quick Checklist
+
+✔ Authoring module exported → `Calendar.mpk`
+✔ Host project committed to `testProjects` (`calendar-web` branch)
+✔ `@mendix/calendar` module package with correct metadata & scripts
+✔ Local `build:module` works
+✔ `release:module` produces `dist/Calendar.mpk`
+
+You now have a fully-packaged module ready for Marketplace users to drag-and-drop without extra configuration.

packages/modules/calendar/.prettierrc.js

@@ -0,0 +1 @@
+module.exports = require("@mendix/prettier-config-web-widgets");

packages/modules/calendar/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this module will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Initial version of Calendar module.

packages/modules/calendar/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Mendix Technology BV
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License. 

packages/modules/calendar/README.md

@@ -0,0 +1,18 @@
+# Calendar module
+
+This module bundles the **Calendar** pluggable widget together with sample pages, domain model, and helper flows so that app builders can drag-and-drop a fully working calendar including _New/Edit Event_ dialog.
+
+## Contents
+
+- Calendar widget (`@mendix/calendar-web`)
+- Pages: `Calendar_Overview`, `Calendar_New Edit Event`
+- Microflows for creating, editing and persisting events
+- Domain model for `CalendarEvent` entity
+
+## Usage
+
+1. Import the module `.mpk` file into your Mendix project.
+2. Drag the _Calendar_Overview_ page into your navigation or use the _Calendar_ page layout.
+3. Customize the microflows or replace the `Event` entity with your own via associations.
+
+For full documentation of widget properties see the [Calendar widget docs](https://docs.mendix.com/appstore/widgets/calendar).