aspnetzero-workflow-designer 1.0.0 → 1.0.1

package/README.md

@@ -1,4 +1,4 @@
-# @aspnetzero/workflow-designer
+# aspnetzero-workflow-designer
 
 Framework-neutral custom elements for the ASP.NET Zero workflow & approval builder.
 One implementation, wrapped by Angular, React and ASP.NET Core MVC — so the three UIs cannot drift apart.
@@ -13,7 +13,7 @@ One implementation, wrapped by Angular, React and ASP.NET Core MVC — so the th
 Both are registered automatically on import.
 
 ```ts
-import '@aspnetzero/workflow-designer';
+import 'aspnetzero-workflow-designer';
 ```
 
 ## The host contract
@@ -137,7 +137,7 @@ Swapping the rendering library must never change the persisted JSON.
 ```html
 <workflow-designer id="designer"></workflow-designer>
 <script type="module">
-    import '@aspnetzero/workflow-designer';
+    import 'aspnetzero-workflow-designer';
 
     const designer = document.getElementById('designer');
 
@@ -159,27 +159,52 @@ npm install
 npm run dev        # demo page at demo/index.html
 npm run typecheck
 npm test           # vitest suite under test/
-npm run build      # ESM + UMD + rolled-up .d.ts into dist/, then syncs the hosts (see below)
+npm run build      # ESM + UMD + rolled-up .d.ts into dist/
 ```
 
 Rendering uses [AntV X6](https://x6.antv.antgroup.com/) — a vanilla-JS graph library, chosen precisely
 because it carries no framework dependency and therefore works identically inside all three host UIs.
 
-### After every change: run `npm run build`
+### How the hosts get the designer
 
-**Whenever you change anything in this package, run `npm run build` here before testing in a host or
-committing.** The hosts never compile `src/`; they only consume the built output:
+The hosts never use this folder. All three install the published `aspnetzero-workflow-designer` package
+from npm, so the three UIs run the same build:
 
 | Host | How it gets the designer |
 |---|---|
-| Angular (`angular/`) | `link:../workflow-designer` dependency, reads `dist/` |
-| React (`react/`) | `link:../workflow-designer` dependency, reads `dist/` |
-| ASP.NET Core MVC (`Web.Mvc`) | a copy of `dist/workflow-designer.umd.cjs`, committed under `wwwroot/view-resources/Areas/AppAreaName/Views/WorkflowDefinitions/lib/workflow-designer.umd.js` |
-
-`npm run build` runs `scripts/sync-hosts.mjs` as its `postbuild` step, which copies the fresh UMD bundle
-into the MVC host. Skipping the build leaves Angular and React on a stale `dist/` and MVC on a stale
-committed bundle, so the three UIs drift apart. Commit the regenerated MVC bundle together with the
-source change. (`npm run sync-hosts` re-runs only the copy step.)
+| Angular (`angular/`) | `aspnetzero-workflow-designer` dependency, imports the ESM build |
+| React (`react/`) | `aspnetzero-workflow-designer` dependency, imports the ESM build |
+| ASP.NET Core MVC (`Web.Mvc`) | `aspnetzero-workflow-designer` dependency; `bundles.json` turns `dist/workflow-designer.umd.cjs` into `_Bundles/workflow-designer.min.js` |
+
+### Releasing a change
+
+1. Change the package, then run `npm test` and `npm run build`.
+2. Raise `version` in `package.json` (a new step kind or input is a minor version, a fix a patch).
+3. Run `npm publish`. `prepublishOnly` runs the tests and the build again, so a broken package is not
+   published.
+4. In `angular/`, `react/` and `aspnet-core/src/MyCompanyName.AbpZeroTemplate.Web.Mvc/`, run
+   `pnpm update aspnetzero-workflow-designer` and commit the lockfiles with the server change that
+   needed the new version.
+
+`WorkflowNodeTypeContract_Tests` and the other contract tests in the server test project read this
+folder's `src/`, so the server and the designer can not drift apart unnoticed.
+
+### Trying a change in a host before publishing
+
+Point a host at this folder for the time being:
+
+```bash
+cd angular            # or react
+pnpm link ../workflow-designer
+
+cd aspnet-core/src/MyCompanyName.AbpZeroTemplate.Web.Mvc
+pnpm link ../../../workflow-designer
+```
+
+The host now reads this folder's `dist/`, so run `npm run build` here after each change (MVC also needs
+`npm run create-bundles`). `pnpm link` adds a `link:` override to the host's `pnpm-workspace.yaml` and
+changes its `pnpm-lock.yaml`; do not commit those. To go back to the published package, revert both files
+and run `pnpm install`.
 
 ## Status