@mohsinonxrm/pptb-dataverse-request-studio 1.5.0-beta.1 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,141 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
+ ## [1.5.0] - 2026-11-07
11
+
12
+ Writes ask before they're sent, naming the environment, and Production gets a
13
+ safe mode that's on by default ([#241]). Read and execute requests send their
14
+ headers, and impersonation is never dropped silently ([#109]). The entity scope
15
+ moves from Settings to a button in the header ([#42]). Ids, names and filter
16
+ values are checked and typed before they go into a URL ([#221]). The sidebar
17
+ works with a screen reader and the keyboard ([#243]).
18
+
19
+ It was iterated through `1.5.0-beta.1` (detailed below). Since that beta, the
20
+ Insider icon, the README badges and the release workflow changed (listed here).
21
+
22
+ Request headers need **Power Platform ToolBox 1.2.7 or later**. On older hosts
23
+ a request with an impersonation header isn't sent, and DRS explains why.
24
+
25
+ ### ✨ Added
26
+
27
+ - **Writes ask before they're sent**, naming the environment and its type, and
28
+ **Production safe mode** is on by default ([#241]).
29
+ - **The entity scope is a button in the header** ([#42]).
30
+ - **Read, Execute Function, Associate / Disassociate and Bulk Delete Job send
31
+ their headers**, and impersonation is never dropped silently ([#109]).
32
+ - **Execute Custom API and Custom Action list your own operations first**.
33
+
34
+ ### 🛡️ Security and data safety
35
+
36
+ - **Ids, names, filter values and function parameters are checked and typed**
37
+ before they go into a URL, and imported saved requests are checked deeply
38
+ ([#221]).
39
+
40
+ ### 🐛 Fixed since 1.4.0
41
+
42
+ Listed under the beta below. Among them: the sidebar with a screen reader and
43
+ the keyboard ([#243]), expired metadata that was served as fresh ([#334]), and
44
+ choosing a file no longer reads it into memory ([#222]).
45
+
46
+ ### 🔄 Changed
47
+
48
+ - **The Insider icon's gold corner is bigger, deeper gold and flush with the
49
+ corner** ([#363]). The old stamp's right point sat inside the hexagon's edge,
50
+ leaving a thin blue gap, and the light gold faded at small sizes. The stamp
51
+ now fills the corner, about 1.5 times larger, in two tones of gold
52
+ (`#CC8A00` and `#F2A100`) split on the same diagonal as the blue.
53
+ Prerelease builds only; the release icon is unchanged. Same change as
54
+ FetchXML Studio.
55
+ - **The README's badges show in the ToolBox** ([#373]). Power Platform ToolBox
56
+ shows a tool's README in a window that only loads images from GitHub, so the
57
+ `img.shields.io` badges didn't appear there. They're now SVG files in
58
+ `assets/badges/`, linked from `raw.githubusercontent.com` as in Command Bar
59
+ Studio and FetchXML Studio, and generated from `package.json` by
60
+ `npm run badges`: version, Power Platform ToolBox ≥ 1.2.0, `@pptb/types`,
61
+ React, TypeScript, Fluent UI and license. The version badge links to npm, in
62
+ place of the npm `latest` and `beta` badges. The links point at `main`, so
63
+ the ToolBox shows them from the 1.5.0 release on.
64
+
65
+ ### 🔧 Internal
66
+
67
+ - **Releases check what they must update** ([#372]). A new `check-release.mjs`
68
+ runs in CI (every PR, and pushes to the long-lived branches) and in the
69
+ release build. It fails when any of these don't match `package.json`'s
70
+ version:
71
+ - the version's shape (`X.Y.Z`, `X.Y.Z-beta.N` or `X.Y.Z-rc.N`);
72
+ - `package-lock.json`;
73
+ - the CHANGELOG (a dated `[X.Y.Z]` section with entries, under a single
74
+ `[Unreleased]`);
75
+ - after the build, the bundled icon (the Insider icon for pre-releases).
76
+
77
+ The GitHub Release notes are built by the same script: the PPTB requirement,
78
+ the CHANGELOG section and a link to the full CHANGELOG, then GitHub's PR
79
+ list. A release no longer falls back to a PR list alone when the section is
80
+ missing, because the check fails first. RELEASING.md gains a table of what
81
+ every release changes and an *After every release* checklist, and forward
82
+ merges now keep the higher version. Ported from FetchXML Studio's check.
83
+ - **The release check covers the README badges** ([#373]): the files in
84
+ `assets/badges/` match `package.json`, the README shows them, and no README
85
+ image comes from `img.shields.io`.
86
+ - **The release workflow is hardened** ([#376]), as FetchXML Studio's was.
87
+ - **Separate jobs:** `release.yml` is split into `build`, `publish` and
88
+ `github-release`. The job that installs and runs the dependencies
89
+ (`npm ci --ignore-scripts`, no cache, tests, build) only reads the
90
+ repository. Only `publish` can get the npm OIDC token, only for a tag push,
91
+ and it installs no project dependencies: it publishes the tarball `build`
92
+ packed. Only `github-release` can write to the repository.
93
+ - **More checks before publishing:** the release build now also runs the
94
+ runtime audit, lint and the root-absolute asset check, so a tag on a commit
95
+ that skipped CI can't publish. The package-contents check now runs on the
96
+ tarball that gets published, not a dry-run pack.
97
+ - **Pinned versions:** npm is pinned to 11.21.1 instead of `npm@latest`, and
98
+ Node to 24.22.0. Actions are pinned by commit SHA (checkout v7.0.1,
99
+ setup-node v7.1.0, upload-artifact v7.0.2, download-artifact v8.0.2), each
100
+ at least 14 days old.
101
+ - **Rehearsal:** running the workflow by hand runs every check and
102
+ `npm publish --dry-run`, with no npm token and no GitHub Release. A stable
103
+ version that isn't on `main` yet rehearses as `latest`, with a warning.
104
+ - **`latest` can't move back:** a stable tag gets `latest` only for main's own
105
+ version line, and a `support/X.Y` commit is checked first. Support branches
106
+ merge forward into `main`, so before this, a support release first published
107
+ (or retried after a failed publish) once its commit had reached `main` would
108
+ have gone to `latest`.
109
+ - **CI** uses the same Node and action pins and `npm ci --ignore-scripts`,
110
+ doesn't keep the checkout's token, and runs the runtime audit.
111
+ - **RELEASING.md** covers the jobs, the pins, re-runs and rehearsals; how to
112
+ bring a `support/X.Y` cut from an older tag onto this workflow before its
113
+ first tag; and the recommended `publish` environment and `v*` tag ruleset.
114
+
115
+ ### ⚠️ Known issues
116
+
117
+ - **`$batch` continue-on-error:** ToolBox's `$batch` response parser fails when
118
+ a failed request is followed by more requests. DRS explains it and suggests
119
+ putting requests that might fail last ([#198]).
120
+ - **Execute modes on very large environments:** ToolBox can't load a
121
+ `$metadata` document over 16 MB until a ToolBox release includes
122
+ [PowerPlatformToolBox/desktop-app#737](https://github.com/PowerPlatformToolBox/desktop-app/pull/737);
123
+ DRS explains the limit ([#79]).
124
+ - **ToolBox VS Code extension:** Monaco's workers may run on the main thread,
125
+ so JSON IntelliSense may not work there ([#255]).
126
+ - **Binary modes** (file / image / attachment) compose the request and its
127
+ code, but Execute returns 501 because ToolBox doesn't expose those
128
+ operations.
129
+
130
+ [#42]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/42
131
+ [#79]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/79
132
+ [#109]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/109
133
+ [#198]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/198
134
+ [#221]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/221
135
+ [#222]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/222
136
+ [#241]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/241
137
+ [#243]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/243
138
+ [#255]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/255
139
+ [#334]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/334
140
+ [#363]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/363
141
+ [#372]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/372
142
+ [#373]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/373
143
+ [#376]: https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues/376
144
+
10
145
  ## [1.5.0-beta.1] - 2026-10-30
11
146
 
12
147
  The first 1.5.0 beta. Writes now ask before they're sent, naming the
package/README.md CHANGED
@@ -9,13 +9,13 @@ file / image / attachment operations.
9
9
  Built for [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) with
10
10
  React 18, Fluent UI v9, TypeScript, and live Dataverse metadata integration.
11
11
 
12
- [![npm](https://img.shields.io/npm/v/@mohsinonxrm/pptb-dataverse-request-studio?label=npm)](https://www.npmjs.com/package/@mohsinonxrm/pptb-dataverse-request-studio)
13
- [![npm beta](https://img.shields.io/npm/v/@mohsinonxrm/pptb-dataverse-request-studio/beta?label=beta&color=orange)](https://www.npmjs.com/package/@mohsinonxrm/pptb-dataverse-request-studio?activeTab=versions)
14
- ![React](https://img.shields.io/badge/React-18-61DAFB?logo=react)
15
- ![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6?logo=typescript)
16
- ![Fluent UI](https://img.shields.io/badge/Fluent%20UI-v9-0078D4?logo=microsoft)
17
- ![PPTB Types](https://img.shields.io/badge/%40pptb%2Ftypes-1.2.7-orange)
18
- ![License](https://img.shields.io/badge/license-AGPL--3.0--only-green)
12
+ [![Version](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/version.svg)](https://www.npmjs.com/package/@mohsinonxrm/pptb-dataverse-request-studio)
13
+ ![Power Platform ToolBox 1.2.0 or later](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/pptb.svg)
14
+ ![@pptb/types 1.2.7](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/pptb-types.svg)
15
+ ![React 18](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/react.svg)
16
+ ![TypeScript 5.9](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/typescript.svg)
17
+ ![Fluent UI v9](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/fluent-ui.svg)
18
+ ![License AGPL-3.0-only](https://raw.githubusercontent.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/refs/heads/main/assets/badges/license.svg)
19
19
 
20
20
  ---
21
21
 
@@ -240,7 +240,7 @@ modes have their own HTTP / fetch / C# / PPTB outputs.
240
240
  Dataverse Request Studio is available as a tool in Power Platform ToolBox.
241
241
  Install it from the tool gallery or load it as a custom tool. Stable releases
242
242
  are published to npm under the `latest` tag. Prereleases of the next version
243
- are published under the `beta` tag (for example `1.5.0-beta.1`) and use the
243
+ are published under the `beta` tag (for example `1.6.0-beta.1`) and use the
244
244
  gold Insider icon.
245
245
 
246
246
  ### Choose the entity scope
@@ -342,8 +342,16 @@ npm run validate
342
342
 
343
343
  # Lint (ESLint, no warnings allowed)
344
344
  npm run lint
345
+
346
+ # Regenerate the README badges in assets/badges/ from package.json
347
+ npm run badges
345
348
  ```
346
349
 
350
+ The badges at the top of this README are SVG files in `assets/badges/`, linked from
351
+ `raw.githubusercontent.com`: Power Platform ToolBox shows the README in a window that only
352
+ loads images from GitHub, so `img.shields.io` badges don't appear there
353
+ ([RELEASING.md](https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/blob/dev/RELEASING.md#readme-images)).
354
+
347
355
  ### Standalone vs PPTB-embedded
348
356
 
349
357
  DRS runs in two modes:
@@ -1,16 +1,19 @@
1
1
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="4 8 56 48" width="56" height="48">
2
- <!-- Variant L — "Insider build" / DRS
3
- Same K chassis + small gold-orange triangle filling the top-right
4
- vertex of the hex = Microsoft Office Insiders precedent.
5
- Gold (#FFB900) is the Microsoft Insiders signature color across
6
- Office / Windows; reads as "Insider build" to anyone in the
7
- Microsoft ecosystem. -->
2
+ <!-- Variant K — "Clean hex split" / DRS
3
+ Just the diagonal two-tone hex + white glyph centered. No stripe,
4
+ no extra ornament — the split alone is the family signature; the
5
+ glyph carries the tool identity.
6
+ Diagonal now runs vertex-to-vertex (top-right vertex (46,8) →
7
+ bottom-left vertex (18,56)) for a geometrically clean split. -->
8
8
 
9
- <path d="M 18 8 L 46 8 L 60 32 L 46 56 L 18 56 L 4 32 Z" fill="#0E5A9C"/>
10
- <polygon points="46,8 60,32 46,56 18,56" fill="#2B8FD9"/>
9
+ <!-- Whole hex starts as deep navy -->
10
+ <path d="M 18 8 L 46 8 L 60 32 L 46 56 L 18 56 L 4 32 Z"
11
+ fill="#0E5A9C"/>
11
12
 
12
- <!-- Insider stamp — gold triangle in top-right vertex -->
13
- <polygon points="46,8 40,8 49,15" fill="#FFB900"/>
13
+ <!-- Lower-right half: brighter blue quadrilateral
14
+ (top-right vertex → right vertex → bottom-right vertex → bottom-left vertex,
15
+ closing edge IS the diagonal split) -->
16
+ <polygon points="46,8 60,32 46,56 18,56" fill="#2B8FD9"/>
14
17
 
15
18
  <!-- Tool glyph — { → } in white -->
16
19
  <path d="M22 22 C 18 22 18 25 18 28 C 18 31 16 33 15 33 C 16 33 18 35 18 38 C 18 41 18 44 22 44"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mohsinonxrm/pptb-dataverse-request-studio",
3
- "version": "1.5.0-beta.1",
3
+ "version": "1.5.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -75,6 +75,7 @@
75
75
  "lint": "eslint . --max-warnings 0",
76
76
  "test": "vitest run",
77
77
  "test:watch": "vitest",
78
+ "badges": "node .github/scripts/write-badges.mjs",
78
79
  "format": "prettier --write .",
79
80
  "format:check": "prettier --check .",
80
81
  "validate": "pptb-validate"