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

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.
Files changed (56) hide show
  1. package/CHANGELOG.md +383 -0
  2. package/LICENSE +661 -661
  3. package/README.md +479 -390
  4. package/SECURITY.md +54 -51
  5. package/dist/assets/AssociateMode-BVHaHiUu.js +1 -0
  6. package/dist/assets/AssociateTargetsEditor-C-QKaWaJ.js +1 -0
  7. package/dist/assets/BatchMode-D1J8HcNO.js +11 -0
  8. package/dist/assets/BinaryColumnPickers-DLIbx4hp.js +1 -0
  9. package/dist/assets/BulkDeleteMode-CFcjcWta.js +1 -0
  10. package/dist/assets/BulkWriteMode-C3ZGwTjw.js +6 -0
  11. package/dist/assets/DisassociateMode-BwMK4UvP.js +2 -0
  12. package/dist/assets/ExecuteWorkflowMode-CkZdayJ4.js +1 -0
  13. package/dist/assets/ManageFileMode-DP3KXgFw.js +1 -0
  14. package/dist/assets/ManageImageMode-F0Dki5VQ.js +1 -0
  15. package/dist/assets/MergeMode-PeKTZ75X.js +1 -0
  16. package/dist/assets/PredefinedQueryMode-CDuc-WrN.js +1 -0
  17. package/dist/assets/RetrieveNextLinkMode-DenFlpEh.js +1 -0
  18. package/dist/assets/cssMode-DXyl4xBX.js +4 -0
  19. package/dist/assets/{freemarker2-CY0Qd_yj.js → freemarker2-CR_qGQP2.js} +2 -2
  20. package/dist/assets/handlebars-Buz2RscQ.js +1 -0
  21. package/dist/assets/html-B66Hfdqd.js +1 -0
  22. package/dist/assets/htmlMode-3ft3GC0g.js +4 -0
  23. package/dist/assets/index-C4fO68cu.js +704 -0
  24. package/dist/assets/javascript-Cy8u5Pbx.js +1 -0
  25. package/dist/assets/jsonMode-CvLp-1ik.js +10 -0
  26. package/dist/assets/liquid-BxIE_8lr.js +1 -0
  27. package/dist/assets/mdx-Bbo0ENZs.js +1 -0
  28. package/dist/assets/{monaco-editor-ErGqj9vD.js → monacoSetup-C4aSY1Tw.js} +193 -183
  29. package/dist/assets/monacoSetup-DvqauXKu.css +1 -0
  30. package/dist/assets/python-B6K3FYWG.js +1 -0
  31. package/dist/assets/razor-7sN2ZaJq.js +1 -0
  32. package/dist/assets/{tsMode-B1b3lx86.js → tsMode-CIH2Hja3.js} +2 -2
  33. package/dist/assets/typescript-rqW7IEk7.js +1 -0
  34. package/dist/assets/xml-Bm2nJGx3.js +1 -0
  35. package/dist/assets/yaml-Z6ahf7o7.js +1 -0
  36. package/{icons/icon-insider.svg → dist/icons/icon.svg} +22 -22
  37. package/dist/index.html +61 -4
  38. package/index.html +60 -1
  39. package/package.json +14 -8
  40. package/dist/assets/cssMode-DHcTSP5p.js +0 -4
  41. package/dist/assets/handlebars-BQEEw1Ke.js +0 -1
  42. package/dist/assets/html-BXibA6yW.js +0 -1
  43. package/dist/assets/htmlMode-BIOKXbRP.js +0 -4
  44. package/dist/assets/index-CCZE1KQi.js +0 -672
  45. package/dist/assets/javascript-BY4qn0pJ.js +0 -1
  46. package/dist/assets/jsonMode-BzZNqTrE.js +0 -10
  47. package/dist/assets/liquid-noPAIv1T.js +0 -1
  48. package/dist/assets/mdx-Ccyf8KqT.js +0 -1
  49. package/dist/assets/monaco-editor-I3pIE735.css +0 -1
  50. package/dist/assets/python-CTl0fa86.js +0 -1
  51. package/dist/assets/razor-DoNzFhT2.js +0 -1
  52. package/dist/assets/typescript-ONTfb8eq.js +0 -1
  53. package/dist/assets/xml-6DyixHd0.js +0 -1
  54. package/dist/assets/yaml-B9La2-TQ.js +0 -1
  55. package/icons/icon.svg +0 -25
  56. package/npm-shrinkwrap.json +0 -3832
package/README.md CHANGED
@@ -1,390 +1,479 @@
1
- # Dataverse Request Studio for Power Platform ToolBox
2
-
3
- A metadata-driven studio for composing, previewing, and executing Microsoft
4
- Dataverse Web API requests — covering OData reads, record writes, table
5
- associations, bound and unbound action/function invocation, on-demand workflows,
6
- and file / image / attachment operations.
7
-
8
- Built for [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) with
9
- React 18, Fluent UI v9, TypeScript, and live Dataverse metadata integration.
10
-
11
- ![Version](https://img.shields.io/badge/version-1.0.0-blue)
12
- ![React](https://img.shields.io/badge/React-18-61DAFB?logo=react)
13
- ![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178C6?logo=typescript)
14
- ![Fluent UI](https://img.shields.io/badge/Fluent%20UI-v9-0078D4?logo=microsoft)
15
- ![PPTB Types](https://img.shields.io/badge/%40pptb%2Ftypes-1.2.1-orange)
16
- ![License](https://img.shields.io/badge/license-AGPL--3.0--only-green)
17
-
18
- ---
19
-
20
- ## ✨ Features
21
-
22
- DRS ships with **17 request modes** organized into 5 functional groups. Every
23
- mode is metadata-driven, generates the correct OData / Web API shape, and
24
- emits ready-to-copy code in five languages (xrm.WebApi single + batch, fetch,
25
- curl, PowerShell).
26
-
27
- ### 📖 Read group
28
-
29
- - **Retrieve Multiple** — full OData query composer with `$select`, `$filter`,
30
- `$orderby`, `$expand`, `$top`, `$skip`, `$count`, `$apply` (groupby /
31
- aggregate), and a virtualized results grid with infinite scroll via
32
- `@odata.nextLink`.
33
- - **Retrieve Single** — by primary key OR by alternate key (composite
34
- alternate keys supported).
35
- - **Retrieve NextLink** — paste a `@odata.nextLink` URL to continue paging
36
- any query.
37
- - **Predefined Query** — execute saved-query (`?savedQuery=<id>`) and
38
- user-query (`?userQuery=<id>`) URLs against an entity set; layout-aware
39
- results grid that matches the source view's column order.
40
-
41
- ### ✏️ Write group
42
-
43
- - **Create Record** — `POST /<set>` with metadata-driven field-set editor.
44
- Required-field guard with red `req` badges, `Prefer: return=representation`
45
- toggle, optional `$select` return list, `MSCRM.*` bypass-header family.
46
- - **Update Record** — `PATCH /<set>(<id>)` multi-field OR
47
- `PUT /<set>(<id>)/<col>` single-column. Diff view (before → after) with
48
- per-row drill-down to switch to PUT mode.
49
- - **Upsert Record** — full upsert / create-only / update-only / etag-guarded
50
- variants. By GUID OR alternate key.
51
- - **Delete Record** — `DELETE /<set>(<id>)` with a typed-confirmation safety
52
- affordance + cascade-impact preview. Single-property delete via
53
- `DELETE /<set>(<id>)/<col>` also supported.
54
- - **Merge Records** — `POST /Merge` for `account` / `contact` / `incident`
55
- with target + subordinate record cards, field-override matrix, and
56
- PerformParentingChecks / SuppressDuplicateDetection settings.
57
-
58
- ### 🔗 Relate group
59
-
60
- - **Associate** — links related records via `POST /<set>(<id>)/<nav>/$ref`
61
- for collection-valued navs, or `PATCH @odata.bind` for single-valued.
62
- Cardinality detected from metadata; verb auto-flips with the picker.
63
- Polymorphic lookups (Customer / Owner / `regardingobjectid`) fully
64
- supported with target-disambiguated nav properties.
65
- - **Disassociate** — `DELETE /$ref` for collection-valued, `PATCH @odata.bind: null`
66
- for single-valued. Same polymorphism story.
67
-
68
- ### ⚡ Execute group
69
-
70
- - **Execute Action** — OOB / Custom API / Custom Action invocation via
71
- bound `POST /<set>(<id>)/Microsoft.Dynamics.CRM.<Action>` OR unbound
72
- `POST /<Action>`. CSDL-driven parameter form with type-aware controls:
73
- required-first UX, Form ↔ JSON toggle, EntityReference / EntityCollection
74
- / Edm primitives / Enum / Status-code OptionSet enrichment.
75
- - **Execute Function** — OData function calls with parameter aliasing
76
- (`?@p1=...`) vs inline literal toggle. CSDL-driven param form with the
77
- same type-aware controls as actions.
78
- - **Execute Workflow** — runs on-demand workflows via
79
- `POST /workflows(<id>)/Microsoft.Dynamics.CRM.ExecuteWorkflow` with the
80
- bound record id. Live picker over activated, on-demand process workflows
81
- (`statecode eq 1 and type eq 1 and ondemand eq true and category eq 0`).
82
-
83
- ### 💾 Binary group
84
-
85
- - **Manage File Data** — File-column upload / download / delete with three
86
- upload paths (single-request PATCH, chunked PATCH with session token,
87
- `InitializeFileBlocksUpload` / `UploadBlock` / `CommitFileBlocksUpload`
88
- messages), four download paths (single GET `/$value`, ranged GET with
89
- `Range`, message-based block download, `GetFileSasUrl` function), and the
90
- `DeleteFile` message + DELETE-on-property alternatives.
91
- - **Manage Image Data** — Image columns with thumbnail vs full-size
92
- download (`?size=full`), `CanStoreFullImage` awareness, and pointers to
93
- the file-column path for full-size uploads.
94
- - **Manage Attachment / Note** — `activitymimeattachment.body` and
95
- `annotation.documentbody`. Inline base 64 OR
96
- `Initialize{Attachment|Annotation}BlocksUpload` /
97
- `Commit{Attachment|Annotation}BlocksUpload` messages. Single-request
98
- GET `/$value` OR `Initialize{...}BlocksDownload` / `DownloadBlock` for
99
- download.
100
-
101
- ### 🔍 Cross-cutting capabilities
102
-
103
- - **Live metadata** — Tables, columns, relationships, alternate keys, action
104
- / function CSDL all fetched lazily from the host's `dataverseAPI`. Per-org
105
- TTL cache with in-flight promise dedup. Type-specific column properties
106
- (Targets, OptionSet, MaxLength, MinValue/MaxValue, Format) loaded on-demand
107
- by the editor that needs them.
108
- - **Antipattern advisories** — Surfaces real-time guidance per the
109
- [Microsoft query-antipatterns doc](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/query-antipatterns):
110
- `FilteringOnCalculatedColumns`, `LargeAmountOfLogicalAttributes`, large-text
111
- `contains`, leading-wildcard rewrites — all flagged inline AND aggregated
112
- into an Advisory drawer in the URL bar.
113
- - **Polymorphic lookup support** — Customer, Owner, and multi-target lookups
114
- (`regardingobjectid`) emit the correct target-disambiguated
115
- `<navName>@odata.bind` binding shape automatically.
116
- - **Code generators** — Every mode emits the same request as
117
- `Xrm.WebApi.online.execute` (single + `executeMultiple` batch),
118
- `fetch`, `curl`, and PowerShell `Invoke-RestMethod` snippets. Multi-request
119
- pipelines (chunked uploads, message-based binary ops) render as full
120
- ordered sequences.
121
- - **Saved-request library** — Per-org localStorage persistence with
122
- auto-suggested names (`account · 3 sel · 2 flt · 2026-05-23`),
123
- rename / delete / overwrite, dirty-state detection, and cross-tab sync.
124
- - **PPTB host integration** — `isEmbedded()`-aware UI: theme sync,
125
- environment-aware URLs, header pass-through, host-stripped header
126
- advisories. Header / theme controls hide when the host owns them.
127
-
128
- ---
129
-
130
- ## 🖼️ Interface overview
131
-
132
- ```
133
- ┌─────────────────────────────────────────────────────────────────────────┐
134
- │ [Request Type ▼] [Group · Method] [⚙ Settings] [Theme] │
135
- ├──────────────────────────┬──────────────────────────────────────────────┤
136
- │ │ [Builder] [Code] [Results] │
137
- │ Sidebar ├──────────────────────────────────────────────┤
138
- │ │ │
139
- │ 📋 Target │ Active editor pane │
140
- │ account │ │
141
- │ 📊 $select 3 sel │ ┌────────────────────────────────────────┐ │
142
- │ 🔍 $filter 2 flt │ │ (clause editor — varies per mode) │ │
143
- │ 🔁 $orderby 1 sort│ │ │ │
144
- │ 🔗 $expand 1 exp │ │ • Field-set editor (writes) │ │
145
- │ 📃 $top │ │ • Filter tree (reads) │ │
146
- │ ⚙ Prefer │ │ • Action param form (executes) │ │
147
- │ 📥 Headers 1 act │ │ • Binary pipeline (file/image) │ │
148
- │ │ └────────────────────────────────────────┘ │
149
- │ ⏱ Recent runs │ │
150
- │ 200 · 142ms · 32B │ │
151
- │ 200 · 89ms │ │
152
- │ │ │
153
- ├──────────────────────────┴──────────────────────────────────────────────┤
154
- │ GET /accounts?$select=name,… 0.4 KB ⚠ 2 advisories │
155
- │ [▶ Execute] │
156
- └─────────────────────────────────────────────────────────────────────────┘
157
- ```
158
-
159
- ---
160
-
161
- ## 🚀 Getting started
162
-
163
- ### Prerequisites
164
-
165
- - [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) (for embedded use)
166
- - A connection to a Dataverse environment
167
- - For local development: **Node.js ≥ 20.19** and **npm**
168
-
169
- ### Installation
170
-
171
- Dataverse Request Studio is available as a tool in Power Platform ToolBox.
172
- Install it from the tool gallery or load it as a custom tool.
173
-
174
- ---
175
-
176
- ## 🛠️ Development
177
-
178
- ### Setup
179
-
180
- ```bash
181
- git clone https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio.git
182
- cd pptb-mxrm-dataverse-request-studio
183
- npm install
184
- ```
185
-
186
- ### Common scripts
187
-
188
- ```bash
189
- # Vite dev server (standalone, no PPTB host)
190
- npm run dev
191
-
192
- # TypeScript-only check (fast)
193
- npm run typecheck
194
-
195
- # Production build
196
- npm run build
197
-
198
- # Preview the production build locally
199
- npm run preview
200
-
201
- # Validate manifest against PPTB registry rules
202
- npm run validate
203
-
204
- # Pre-publish: validate → build → shrinkwrap
205
- npm run finalize-package
206
- ```
207
-
208
- ### Standalone vs PPTB-embedded
209
-
210
- DRS runs in two modes:
211
-
212
- - **Standalone** (`npm run dev`) — opens in a regular browser tab. Useful
213
- for UI iteration. Execute will return `501 Not Implemented` for any
214
- operation because the host bridge isn't present; you can still build
215
- requests, preview URLs, and use the Code tab.
216
- - **Embedded in PPTB** — loads inside the PPTB iframe. The host injects
217
- `window.dataverseAPI` (typed) and `window.toolboxAPI`. Execute runs
218
- against the active Dataverse connection.
219
-
220
- See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for branch conventions,
221
- commit style, code style, and PR guidance.
222
-
223
- ---
224
-
225
- ## 📦 Tech stack
226
-
227
- | Technology | Version | Purpose |
228
- |---|---|---|
229
- | **React** | 18.3 | UI framework |
230
- | **TypeScript** | 5.9 | Strict mode, discriminated unions |
231
- | **Vite** | 7 | Build tooling + HMR |
232
- | **Fluent UI v9** | 9.73 | Microsoft design system (Combobox, DataGrid, Tree, Drawer, Tabs, etc.) |
233
- | **Monaco Editor** | 0.54 | JSON / code editor for body authoring and Code tab |
234
- | **@fluentui-contrib/react-data-grid-react-window** | 1.4 | Virtualized results grid |
235
- | **@dnd-kit** | 6.3 | Drag-reordering for filter / orderby / select clauses |
236
- | **@pptb/types** | 1.2.1 | Power Platform ToolBox host API types |
237
-
238
- ---
239
-
240
- ## 📁 Project layout
241
-
242
- ```
243
- src/
244
- App.tsx — root, ThemedApp, Frame, mode router
245
- main.tsx — Vite entry point
246
-
247
- modes/ — one file per request mode (17 modes)
248
- RetrieveMultipleMode.tsx
249
- RetrieveSingleMode.tsx
250
- RetrieveNextLinkMode.tsx
251
- PredefinedQueryMode.tsx
252
- CreateMode.tsx / UpdateMode.tsx / UpsertMode.tsx / DeleteMode.tsx
253
- MergeMode.tsx
254
- AssociateMode.tsx / DisassociateMode.tsx
255
- ExecuteActionMode.tsx / ExecuteFunctionMode.tsx / ExecuteWorkflowMode.tsx
256
- ManageFileMode.tsx / ManageImageMode.tsx / ManageAttachmentMode.tsx
257
-
258
- editors/ — clause editors shared across modes
259
- filter/ — FilterEditor + value inputs + operator catalog
260
- FieldSetEditor.tsx — metadata-driven write-side form
261
- SelectEditor.tsx, OrderbyEditor.tsx, ExpandEditor.tsx, ApplyEditor.tsx
262
- ActionParamForm.tsx — CSDL-driven action / function params
263
- BinarySourceCard.tsx, BinaryPipelineCard.tsx, BinaryColumnPickers.tsx
264
- HeadersEditor.tsx, BypassEditor.tsx
265
- ActionPicker.tsx, RecordPicker.tsx, EntityListPicker.tsx
266
- ...
267
-
268
- engine/ — URL / body construction + code generation
269
- urlBuilder.ts — central URL builder for every mode
270
- executeBuilders.ts — action / function / workflow body builders
271
- binaryBuilders.ts — file / image / attachment pipelines
272
- codeGenerators.ts — xrm, xrm-batch, fetch, curl, PowerShell
273
- runtime.ts — single dispatch point for execute
274
- dataverseExecutor.ts — live executor over the host's dataverseAPI
275
- odataParser.ts — round-trips OData URL strings ↔ state
276
-
277
- host/ — PPTB bridge + metadata loaders
278
- pptbBridge.ts — typed wrapper over window.dataverseAPI
279
- metadataProvider.ts — entity / attribute / relationship loaders
280
- csdlProvider.ts — $metadata XML parsing + action / function index
281
- cache.ts — singleton TTL cache with in-flight dedup
282
- useLiveMetadata.ts, useColumnDetail.ts, useScopedEntities.ts, …
283
-
284
- primitives/ — small reusable UI bits
285
- Sidebar.tsx, ClauseTreeItem.tsx, SectionHeader.tsx, ModeCard.tsx
286
- StatusPill.tsx, MethodPill.tsx, AdvisoryDrawer.tsx, advisories.ts
287
- NavPathColumnPicker.tsx — N:1 drill-down column picker for filter / apply
288
- KvGrid.tsx, Sortable.tsx, SegmentedToggle.tsx, …
289
-
290
- shell/ — frame / header / URL bar / tabs / drawers
291
- Frame.tsx, FrameHeader.tsx, ModeShell.tsx
292
- UrlBar.tsx, MainTabs.tsx, SettingsDrawer.tsx
293
-
294
- state/ — per-mode state shapes + persistence
295
- readState.ts, writeState.ts, relateState.ts, executeState.ts, binaryState.ts
296
- savedRequests.ts — localStorage persistence (per-org scope)
297
- SaveContext.tsx — cross-mode save/load context
298
- displaySettings.ts — display preferences
299
-
300
- registry/ — request-type catalogue
301
- requestTypes.ts — 17 request types grouped into 5 groups
302
-
303
- views/ — output panes
304
- CodeView.tsx — Code tab: xrm/xrm-batch/fetch/curl/powershell
305
- ResultsView.tsx — tabs (Detail/Grid/JSON/Headers) + error state
306
- results/ — grid + cell renderers + flattening
307
- detail/ — record detail card
308
-
309
- theme/ — Fluent theme + studio-owned brand vars
310
- ```
311
-
312
- ---
313
-
314
- ## 📋 Web API coverage
315
-
316
- | Operation | Status |
317
- |---|---|
318
- | Retrieve Multiple (full OData) | ✅ |
319
- | Retrieve Single (by GUID / alt key) | ✅ |
320
- | `@odata.nextLink` paging | ✅ |
321
- | Predefined / user queries | ✅ |
322
- | `$apply` (groupby / aggregate) | ✅ |
323
- | Lambda filter (`any` / `all`) | ✅ |
324
- | `$expand` (single + collection, nested) | ✅ |
325
- | Polymorphic lookups (Customer, Owner, regardingobjectid) | ✅ |
326
- | Create / Update / Upsert / Delete | ✅ |
327
- | `Prefer: return=representation` | ✅ |
328
- | Optimistic concurrency (`If-Match` ETag) | ✅ |
329
- | `MSCRM.*` bypass family (custom plug-ins, flows, async) | ✅ |
330
- | Single-property PUT / DELETE | ✅ |
331
- | Alternate-key upsert | ✅ |
332
- | Associate / Disassociate (collection + single-valued) | ✅ |
333
- | Merge (account / contact / incident) | ✅ |
334
- | Execute Action (OOB / Custom API / Custom Action) | ✅ |
335
- | Execute Function | ✅ |
336
- | Execute Workflow | ✅ |
337
- | File column (upload / download / delete) | ✅ |
338
- | Image column (thumbnail / full-size) | ✅ |
339
- | Attachment / Note (inline + message-based) | ✅ |
340
- | `$batch` envelope composer | ⏳ (see roadmap) |
341
- | `CreateMultiple` / `UpdateMultiple` / `DeleteMultiple` | ⏳ |
342
- | `BulkDelete` async job | ⏳ |
343
- | `ExecuteMultiple` envelope | ⏳ |
344
-
345
- ---
346
-
347
- ## 🤝 Contributing
348
-
349
- See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for branch conventions,
350
- commit style, code style, repo layout, and PR guidance.
351
-
352
- ---
353
-
354
- ## 📋 Roadmap
355
-
356
- - `$batch` envelope composer mode
357
- - Bulk-write modes (`CreateMultiple`, `UpdateMultiple`, `DeleteMultiple`)
358
- - `BulkDelete` async-job composer
359
- - `ExecuteMultiple` request envelope
360
- - Recent-runs click-to-reload
361
- - WriteResultCard "Retrieve this record" cross-mode jump
362
- - EntitySpecific param — reference vs new-instance toggle
363
- - Workflow input parameters (parse XAML `InArgument`)
364
- - Predefined Query — apply to related collection
365
- - CSV / JSON export from results grid
366
- - Column resize with persisted widths
367
- - Smoke-test suite covering URL builders + code generators
368
-
369
- ---
370
-
371
- ## 📄 License
372
-
373
- Licensed under the **GNU Affero General Public License v3.0** (AGPL-3.0-only).
374
- See [LICENSE](LICENSE) for details.
375
-
376
- ---
377
-
378
- ## 🙏 Acknowledgments
379
-
380
- - [Dataverse REST Builder](https://github.com/GuidoPreite/DRB) - Original inspiration.
381
- - [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) — host
382
- platform for the desktop / web app where DRS runs.
383
- - [FetchXML Studio](https://github.com/mohsinonxrm/pptb-mxrm-fetchxml-studio) — sibling tool that pioneered many of the patterns
384
- reused here (metadata cache, scope settings, results grid).
385
- - [Fluent UI](https://react.fluentui.dev/) — UI component library.
386
- - [Monaco Editor](https://microsoft.github.io/monaco-editor/) — VS Code's editor core.
387
-
388
- ---
389
-
390
- Built with ❤️ for the Power Platform community.
1
+ # Dataverse Request Studio for Power Platform ToolBox
2
+
3
+ A metadata-driven studio for composing, previewing, and executing Microsoft
4
+ Dataverse Web API requests — covering OData reads, record writes, bulk writes
5
+ and bulk-delete jobs, table associations, bound and unbound action/function
6
+ invocation, on-demand workflows, `$batch` / ExecuteMultiple envelopes, and
7
+ file / image / attachment operations.
8
+
9
+ Built for [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) with
10
+ React 18, Fluent UI v9, TypeScript, and live Dataverse metadata integration.
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)
19
+
20
+ ---
21
+
22
+ ## ✨ Features
23
+
24
+ DRS ships with **23 request modes** in 7 groups. Every mode is
25
+ metadata-driven and generates the correct OData / Web API shape. The
26
+ single-request modes emit ready-to-copy code in ten formats: `fetch`, `Xrm.WebApi`,
27
+ `Xrm.WebApi.executeMultiple`, `XMLHttpRequest`, Power Automate, C#, PowerShell,
28
+ cURL, JSON, and an OpenAPI 3 document; the `$batch` and ExecuteMultiple
29
+ modes have their own HTTP / fetch / C# / PPTB outputs.
30
+
31
+ ### 📖 Read group
32
+
33
+ - **Retrieve Multiple** — full OData query composer with `$select`, `$filter`,
34
+ `$orderby`, `$expand` (nested, with inner `$filter` / `$orderby` / `$top`),
35
+ `$top`, `$count`, `$apply` (groupby / aggregate), and a virtualized results
36
+ grid with infinite scroll via `@odata.nextLink`, **Retrieve all**, CSV / JSON
37
+ export, per-column filters, row search, density and persisted column widths.
38
+ Address shortcut chips in the `$filter` builder; paste any OData URL to load
39
+ it into the builder.
40
+ - **Retrieve Single** — one record by primary key (GUID), with `$select` /
41
+ `$expand`.
42
+ - **Retrieve NextLink** — paste a `@odata.nextLink` URL to continue paging
43
+ any query.
44
+ - **Predefined Query** — execute saved-query (`?savedQuery=<id>`) and
45
+ user-query (`?userQuery=<id>`) URLs against an entity set, or over a row's
46
+ related records; layout-aware results grid that matches the source view's
47
+ column order.
48
+
49
+ ### ✏️ Write group
50
+
51
+ - **Create Record** — `POST /<set>` with a metadata-driven field-set editor or
52
+ a raw JSON body. Required-field guard, `Prefer: return=representation`,
53
+ optional `$select` return list, duplicate detection and the `MSCRM.*`
54
+ bypass-header family. **Retrieve this record** from the result card.
55
+ - **Update Record** — `PATCH /<set>(<id>)` multi-field OR
56
+ `PUT /<set>(<id>)/<col>` single-column (Code tab only), with a before →
57
+ after diff.
58
+ **Require existing record** (`If-Match: *`) is the default, so a wrong GUID
59
+ returns 404 instead of creating a record.
60
+ - **Upsert Record** — full upsert / create-only / update-only / ETag-guarded
61
+ variants, by GUID or alternate key (alternate key: Code tab only).
62
+ - **Delete Record** — `DELETE /<set>(<id>)` with a typed-confirmation safety
63
+ affordance + cascade-impact preview. Single-property delete via
64
+ `DELETE /<set>(<id>)/<col>` is composed for the Code tab.
65
+ - **Merge Records** — `POST /Merge` for `account` / `contact` / `lead` /
66
+ `incident` with target + subordinate record cards, field-override matrix,
67
+ and PerformParentingChecks / SuppressDuplicateDetection settings.
68
+
69
+ ### 📦 Bulk group
70
+
71
+ - **Bulk Write** — `CreateMultiple` / `UpdateMultiple` / `UpsertMultiple` /
72
+ `DeleteMultiple` over a grid of rows, with a per-table support check.
73
+ - **Bulk Delete Job** — a `BulkDelete` system job built from a query, with a
74
+ scheduled or immediate start and live job-status polling.
75
+
76
+ ### 🔗 Relate group
77
+
78
+ - **Associate** — links related records via `POST /<set>(<id>)/<nav>/$ref`
79
+ for collection-valued navs (one request per target, already-linked targets
80
+ skipped), or `PATCH @odata.bind` for single-valued. Cardinality detected
81
+ from metadata; verb auto-flips with the picker. Polymorphic lookups
82
+ (Customer / Owner / `regardingobjectid`) fully supported.
83
+ - **Disassociate** — `DELETE /$ref` for collection-valued, `PATCH @odata.bind: null`
84
+ for single-valued. Same polymorphism story.
85
+ - Single-valued PATCHes carry `If-Match: *`, so a wrong source id can't create
86
+ a record. Multi-target results are reported per target.
87
+
88
+ ### ⚡ Execute group
89
+
90
+ - **Execute Action** — OOB action invocation via bound
91
+ `POST /<set>(<id>)/Microsoft.Dynamics.CRM.<Action>`, collection-bound, OR
92
+ unbound `POST /<Action>`. CSDL-driven parameter form with type-aware
93
+ controls: required-first UX, Form ↔ JSON toggle, EntityReference (existing
94
+ record) or EntitySpecific (existing record or new instance) /
95
+ EntityCollection / Edm primitives / collections / Enum / OptionSet
96
+ enrichment.
97
+ - **Execute Custom API** / **Execute Custom Action** — the same composer,
98
+ listing every Custom API and every custom process action, Microsoft's own
99
+ included. Classification comes from Dataverse data (`customapi`,
100
+ `workflow` + `sdkmessage`); the name is only a fallback when those lookups
101
+ fail.
102
+ - **Execute Function** — OData function calls with parameter aliasing
103
+ (`?@p1=...`) vs inline literals, valid OData literals and escaping, run from
104
+ the built URL.
105
+ - **Execute Workflow** — runs on-demand workflows via
106
+ `POST /workflows(<id>)/Microsoft.Dynamics.CRM.ExecuteWorkflow` with the
107
+ bound record id, showing the workflow's declared input arguments.
108
+
109
+ ### 🧺 Batch group
110
+
111
+ - **`$batch` Request** — compose a `$batch` from groups of requests: change
112
+ sets (atomic, with `$n` Content-ID references) or independent requests, with
113
+ continue-on-error. Add the last request of a read, write, relate or execute
114
+ mode; per-part results with
115
+ status and body. A batch that mixes change sets and independent requests
116
+ is sent as consecutive ToolBox calls. Needs PPTB 1.2.7+.
117
+ - **ExecuteMultiple** — the ExecuteMultiple pattern (independent requests,
118
+ continue-on-error, return responses) on the `$batch` engine, with SDK
119
+ `ExecuteMultipleRequest` (C#), raw `$batch` and PPTB code. Needs PPTB
120
+ 1.2.7+.
121
+
122
+ ### 💾 Binary group
123
+
124
+ - **Manage File Data** — File-column upload / download / delete with three
125
+ upload paths (single-request PATCH, chunked PATCH with session token,
126
+ `InitializeFileBlocksUpload` / `UploadBlock` / `CommitFileBlocksUpload`
127
+ messages), four download paths (single GET `/$value`, ranged GET with
128
+ `Range`, message-based block download, `GetFileSasUrl` function), and the
129
+ `DeleteFile` message + DELETE-on-property alternatives.
130
+ - **Manage Image Data** — Image columns with thumbnail vs full-size
131
+ download (`?size=full`), `CanStoreFullImage` awareness, and pointers to
132
+ the file-column path for full-size uploads.
133
+ - **Manage Attachment / Note** — `activitymimeattachment.body` and
134
+ `annotation.documentbody`. Inline base 64 OR
135
+ `Initialize{Attachment|Annotation}BlocksUpload` /
136
+ `Commit{Attachment|Annotation}BlocksUpload` messages. Single-request
137
+ GET `/$value` OR `Initialize{...}BlocksDownload` / `DownloadBlock` for
138
+ download.
139
+
140
+ > The binary modes compose the request pipeline and its code, but the PPTB
141
+ > Dataverse API doesn't expose these chunked operations, so **Execute returns
142
+ > `501 Not Implemented`** in this group. Run the generated code from the Code
143
+ > tab instead.
144
+
145
+ ### 🔍 Cross-cutting capabilities
146
+
147
+ - **Live metadata** — Tables, columns, relationships, alternate keys, action
148
+ / function CSDL all fetched lazily from the host's `dataverseAPI`, cached per
149
+ org with in-flight promise dedup. Switching the PPTB connection resets the
150
+ prepared request and reloads metadata for the new environment.
151
+ - **Request headers through PPTB 1.2.7+** — Create / Update / Upsert /
152
+ Delete / Merge / Bulk Write headers (preconditions, `MSCRM.*` bypass, duplicate detection, impersonation) are
153
+ sent as additional headers after you approve them once in ToolBox. On older
154
+ hosts, requests that depend on a header are blocked with an explanation.
155
+ `Authorization` / `Cookie` headers are never sent, saved or exported.
156
+ - **Antipattern advisories** — Surfaces real-time guidance per the
157
+ [Microsoft query-antipatterns doc](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/query-antipatterns):
158
+ `FilteringOnCalculatedColumns`, `LargeAmountOfLogicalAttributes`, large-text
159
+ `contains`, leading-wildcard rewrites — all flagged inline AND aggregated
160
+ into an Advisory drawer in the URL bar.
161
+ - **Polymorphic lookup support** — Customer, Owner, and multi-target lookups
162
+ (`regardingobjectid`) emit the correct target-disambiguated
163
+ `<navName>@odata.bind` binding shape automatically.
164
+ - **Code generators** — Every single-request mode emits the same request as `fetch`,
165
+ `Xrm.WebApi` (CRUD helpers or `Xrm.WebApi.online.execute`),
166
+ `Xrm.WebApi.online.executeMultiple`, `XMLHttpRequest`, C# `HttpClient`,
167
+ PowerShell `Invoke-RestMethod`, cURL, a JSON description and an OpenAPI 3
168
+ document, plus a field-by-field Power Automate (Dataverse connector) sheet.
169
+ Multi-request pipelines render as full ordered sequences.
170
+ - **Saved-request library** — per-connection, versioned, up to 200 requests
171
+ across all modes, with auto-suggested names, rename / delete / overwrite and
172
+ dirty-state detection. Export / import as JSON, export as a Postman /
173
+ Insomnia / Bruno collection, and copy or move requests from other
174
+ connections. A library that can't be read is never overwritten.
175
+ - **Recent runs** — click a run to restore it into its mode. Each mode keeps
176
+ its unsaved request when you switch modes.
177
+ - **Results** — CSV export (formulas neutralised for spreadsheets), JSON
178
+ export, Copy as TSV, and response-size hints.
179
+ - **Accessibility** — labelled inputs, readable badges and live-region
180
+ announcements; render errors are contained per pane.
181
+
182
+ ---
183
+
184
+ ## 🖼️ Interface overview
185
+
186
+ ```
187
+ ┌─────────────────────────────────────────────────────────────────────────┐
188
+ │ [Request Type ▼] [Group · Method] [⚙ Settings] [Theme] │
189
+ ├──────────────────────────┬──────────────────────────────────────────────┤
190
+ │ │ [Builder] [Code] [Results] │
191
+ │ Sidebar ├──────────────────────────────────────────────┤
192
+ │ │ │
193
+ │ 📋 Target │ Active editor pane │
194
+ │ account │ │
195
+ │ 📊 $select 3 sel │ ┌────────────────────────────────────────┐ │
196
+ │ 🔍 $filter 2 flt │ │ (clause editor — varies per mode) │ │
197
+ │ 🔁 $orderby 1 sort│ │ │ │
198
+ │ 🔗 $expand 1 exp │ │ • Field-set editor (writes) │ │
199
+ │ 📃 $top │ │ • Filter tree (reads) │ │
200
+ │ ⚙ Prefer │ │ • Action param form (executes) │ │
201
+ │ 📥 Headers 1 act │ │ • Binary pipeline (file/image) │ │
202
+ │ │ └────────────────────────────────────────┘ │
203
+ │ ⏱ Recent runs │ │
204
+ │ 200 · 142ms · 32B │ │
205
+ │ 200 · 89ms │ │
206
+ │ │ │
207
+ ├──────────────────────────┴──────────────────────────────────────────────┤
208
+ │ GET /accounts?$select=name,… 0.4 KB ⚠ 2 advisories │
209
+ │ [▶ Execute] │
210
+ └─────────────────────────────────────────────────────────────────────────┘
211
+ ```
212
+
213
+ ---
214
+
215
+ ## 🚀 Getting started
216
+
217
+ ### Prerequisites
218
+
219
+ - [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) **1.2.0 or
220
+ later** (the tool declares `minAPI: 1.2.0`). **1.2.7 or later** is
221
+ recommended: it sends the write modes' request headers and is required for
222
+ the `$batch` and ExecuteMultiple modes.
223
+ - A connection to a Dataverse environment
224
+ - For local development: **Node.js 22.22.2+, 24.15+ or 26+** and **npm** (see
225
+ `engines` in `package.json`)
226
+
227
+ ### Installation
228
+
229
+ Dataverse Request Studio is available as a tool in Power Platform ToolBox.
230
+ Install it from the tool gallery or load it as a custom tool. Prereleases are
231
+ published to npm under the `beta` tag (for example `1.4.0-beta.1`) and use the
232
+ gold Insider icon.
233
+
234
+ ---
235
+
236
+ ## 🛠️ Development
237
+
238
+ ### Setup
239
+
240
+ ```bash
241
+ git clone https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio.git
242
+ cd pptb-mxrm-dataverse-request-studio
243
+ npm install
244
+ ```
245
+
246
+ ### Common scripts
247
+
248
+ ```bash
249
+ # Vite dev server (standalone, no PPTB host)
250
+ npm run dev
251
+
252
+ # TypeScript-only check (fast)
253
+ npm run typecheck
254
+
255
+ # Unit tests (Vitest)
256
+ npm test
257
+
258
+ # Production build
259
+ npm run build
260
+
261
+ # Bundle size report
262
+ npm run build:analyze
263
+
264
+ # Preview the production build locally
265
+ npm run preview
266
+
267
+ # Validate manifest against PPTB registry rules
268
+ npm run validate
269
+
270
+ # Pre-publish: validate → build
271
+ npm run finalize-package
272
+ ```
273
+
274
+ ### Standalone vs PPTB-embedded
275
+
276
+ DRS runs in two modes:
277
+
278
+ - **Standalone** (`npm run dev`) — opens in a regular browser tab. Useful
279
+ for UI iteration only: without the host bridge no live metadata loads, and
280
+ Execute returns `501 Not Implemented` ("Running standalone: Execute needs
281
+ the PPTB host"); the Bulk modes report it as an error result.
282
+ - **Embedded in PPTB** — loads inside the PPTB iframe. The host injects
283
+ `window.dataverseAPI` (typed) and `window.toolboxAPI`. Execute runs
284
+ against the active Dataverse connection.
285
+
286
+ See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for branch conventions,
287
+ commit style, code style, and PR guidance.
288
+
289
+ ---
290
+
291
+ ## 📦 Tech stack
292
+
293
+ | Technology | Version | Purpose |
294
+ |---|---|---|
295
+ | **React** | 18.3 | UI framework |
296
+ | **TypeScript** | 5.9 | Strict mode, discriminated unions |
297
+ | **Vite** | 7 | Build tooling + HMR |
298
+ | **Fluent UI v9** | 9.73 | Microsoft design system (Combobox, DataGrid, Tree, Drawer, Tabs, etc.) |
299
+ | **Monaco Editor** | 0.54 | JSON / code editor for body authoring and Code tab |
300
+ | **@fluentui-contrib/react-data-grid-react-window** | 1.4 | Virtualized results grid |
301
+ | **@dnd-kit** | 6.3 | Drag-reordering for filter / orderby / select clauses |
302
+ | **@pptb/types** | 1.2.7 | Power Platform ToolBox host API types |
303
+ | **Vitest** | 5 | Unit tests (request engine, code generators, storage) |
304
+
305
+ ---
306
+
307
+ ## 📁 Project layout
308
+
309
+ ```
310
+ src/
311
+ App.tsx — root, ThemedApp, Frame, mode router
312
+ main.tsx — Vite entry point
313
+
314
+ modes/ — request-mode components (23 modes)
315
+ RetrieveMultipleMode.tsx
316
+ RetrieveSingleMode.tsx
317
+ RetrieveNextLinkMode.tsx
318
+ PredefinedQueryMode.tsx
319
+ CreateMode.tsx / UpdateMode.tsx / UpsertMode.tsx / DeleteMode.tsx
320
+ MergeMode.tsx
321
+ AssociateMode.tsx / DisassociateMode.tsx
322
+ ExecuteActionMode.tsx — Execute Action / Custom API / Custom Action
323
+ ExecuteFunctionMode.tsx / ExecuteWorkflowMode.tsx
324
+ ManageFileMode.tsx / ManageImageMode.tsx / ManageAttachmentMode.tsx
325
+ BulkWriteMode.tsx / BulkDeleteMode.tsx
326
+ BatchMode.tsx + batch/ — $batch Request and ExecuteMultiple
327
+ StubMode.tsx — fallback for an unknown mode id
328
+
329
+ editors/ — clause editors shared across modes
330
+ filter/ — FilterEditor + value inputs + operator catalog
331
+ expand/ — $expand tree navigation
332
+ FieldSetEditor.tsx — metadata-driven write-side form
333
+ SelectEditor.tsx, OrderbyEditor.tsx, ExpandEditor.tsx, ApplyEditor.tsx
334
+ ActionParamForm.tsx — CSDL-driven action / function params
335
+ BinarySourceCard.tsx, BinaryPipelineCard.tsx, BinaryColumnPickers.tsx
336
+ HeadersEditor.tsx, BypassEditor.tsx, PreconditionEditor.tsx
337
+ ActionPicker.tsx, NavPropertyPicker.tsx, PasteODataDialog.tsx
338
+ ...
339
+
340
+ engine/ — URL / body construction + code generation
341
+ urlBuilder.ts — central URL builder for every mode
342
+ executeBuilders.ts — action / function / workflow body builders
343
+ binaryBuilders.ts — file / image / attachment pipelines
344
+ codeGenerators.ts — fetch, Xrm.WebApi (+ executeMultiple), XHR,
345
+ Power Automate, C#, PowerShell, cURL, JSON
346
+ openApiGenerator.ts — OpenAPI 3 document for the current request
347
+ collectionFormats.ts, savedToCollection.ts
348
+ — Postman / Insomnia / Bruno collection export
349
+ bulkWrite*.ts, bulkDelete*.ts, batch/
350
+ — Bulk Write, Bulk Delete Job, $batch engine
351
+ sensitiveHeaders.ts — credential / impersonation header policy
352
+ runtime.ts — single dispatch point for execute
353
+ dataverseExecutor.ts — live executor over the host's dataverseAPI
354
+ odataParser.ts — round-trips OData URL strings ↔ state
355
+ antipatterns.tsx, bypassAdvisories.tsx, hostHeaderAdvisories.tsx
356
+ — advisory detectors
357
+
358
+ host/ — PPTB bridge + metadata loaders
359
+ pptbBridge.ts — typed wrapper over window.dataverseAPI
360
+ metadataProvider.ts — entity / attribute / relationship loaders
361
+ csdlProvider.ts — $metadata XML parsing + action / function index
362
+ cache.ts — singleton TTL cache with in-flight dedup
363
+ useLiveMetadata.ts, useColumnDetail.ts, useScopedEntities.ts, …
364
+
365
+ primitives/ — small reusable UI bits
366
+ ClauseTreeItem.tsx, SectionHeader.tsx, ModeCard.tsx, RequestTypePicker.tsx
367
+ StatusPill.tsx, MethodPill.tsx, AdvisoryDrawer.tsx, advisories.ts
368
+ NavPathColumnPicker.tsx — N:1 drill-down column picker for filter / apply
369
+ RecordPicker.tsx, KvGrid.tsx, Sortable.tsx, SegmentedToggle.tsx, …
370
+
371
+ shell/ — header / sidebar / URL bar / tabs / drawers
372
+ FrameHeader.tsx, ModeShell.tsx, Sidebar.tsx
373
+ UrlBar.tsx, UrlTokens.tsx, MainTabs.tsx, SettingsDrawer.tsx
374
+
375
+ state/ — per-mode state shapes + persistence
376
+ readState.ts, writeState.ts, relateState.ts, executeState.ts, binaryState.ts
377
+ savedRequests.ts — localStorage persistence (per-org scope)
378
+ useSavedRequests.tsx — shared saved-request store
379
+ modeDrafts.ts — unsaved request per mode (this session)
380
+ SaveContext.tsx — cross-mode save/load context
381
+ validateRequest.tsx — pre-execute request validation
382
+ displaySettings.ts — display preferences
383
+
384
+ registry/ — request-type catalogue
385
+ requestTypes.ts — 23 request types grouped into 7 groups
386
+
387
+ views/ — output panes
388
+ CodeView.tsx — Code tab: one sub-tab per code format
389
+ PowerAutomatePane.tsx — Power Automate field-by-field sheet
390
+ ResultsView.tsx — tabs (Detail/Grid/JSON/Headers) + error state
391
+ results/ — grid + cell renderers + flattening
392
+ detail/ — record detail card
393
+
394
+ theme/ — Fluent theme + studio-owned brand vars
395
+ ```
396
+
397
+ ---
398
+
399
+ ## 📋 Web API coverage
400
+
401
+ ✅ = compose + Execute in PPTB · ✅ 1.2.7+ = Execute needs PPTB 1.2.7 or
402
+ later · 📝 = compose + Code tab only (not available through the PPTB
403
+ Dataverse API)
404
+
405
+ | Operation | Status |
406
+ |---|---|
407
+ | Retrieve Multiple (full OData) | ✅ |
408
+ | Retrieve Single (by GUID) | ✅ |
409
+ | `@odata.nextLink` paging, Retrieve all | ✅ |
410
+ | Predefined / user queries (incl. over related records) | ✅ |
411
+ | `$apply` (groupby / aggregate) | ✅ |
412
+ | Lambda filter (`any` / `all`) | ✅ |
413
+ | `$expand` (single + collection, nested) | ✅ |
414
+ | Polymorphic lookups (Customer, Owner, regardingobjectid) | ✅ |
415
+ | Create / Update / Upsert / Delete | ✅ |
416
+ | `Prefer: return=representation` | ✅ (ToolBox always sends it on writes) |
417
+ | Optimistic concurrency (`If-Match` / `If-None-Match`) | ✅ 1.2.7+ |
418
+ | `MSCRM.*` bypass family (custom plug-ins, flows, async) | ✅ 1.2.7+ |
419
+ | Single-property PUT / DELETE | 📝 |
420
+ | Alternate-key upsert | 📝 |
421
+ | Associate / Disassociate (collection + single-valued) | ✅ |
422
+ | Merge (account / contact / lead / incident) | ✅ |
423
+ | Execute Action (OOB / Custom API / Custom Action) | ✅ |
424
+ | Execute Function | ✅ |
425
+ | Execute Workflow | ✅ |
426
+ | `CreateMultiple` / `UpdateMultiple` / `UpsertMultiple` / `DeleteMultiple` | ✅ |
427
+ | `BulkDelete` async job | ✅ |
428
+ | `$batch` (change sets + independent requests) | ✅ 1.2.7+ |
429
+ | `ExecuteMultiple` pattern | ✅ 1.2.7+ |
430
+ | File column (upload / download / delete) | 📝 |
431
+ | Image column (thumbnail / full-size) | 📝 |
432
+ | Attachment / Note (inline + message-based) | 📝 |
433
+
434
+ ---
435
+
436
+ ## 🤝 Contributing
437
+
438
+ See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for branch conventions,
439
+ commit style, code style, repo layout, and PR guidance.
440
+
441
+ ---
442
+
443
+ ## 📋 Roadmap
444
+
445
+ Planned work is tracked in the repository's
446
+ [milestones](https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/milestones)
447
+ and [issues](https://github.com/mohsinonxrm/pptb-mxrm-dataverse-request-studio/issues).
448
+ Ideas under consideration include:
449
+
450
+ - Request variables (`{{var}}`) and persistent request history
451
+ - FetchXML and Dataverse Search API modes
452
+ - A metadata browser mode
453
+ - Comparing responses across runs or environments
454
+ - Importing Postman / Insomnia collections and cURL commands
455
+ - More code-generation targets (C# ServiceClient / IOrganizationService,
456
+ Python, the PowerShell Dataverse module)
457
+
458
+ ---
459
+
460
+ ## 📄 License
461
+
462
+ Licensed under the **GNU Affero General Public License v3.0** (AGPL-3.0-only).
463
+ See [LICENSE](LICENSE) for details.
464
+
465
+ ---
466
+
467
+ ## 🙏 Acknowledgments
468
+
469
+ - [Dataverse REST Builder](https://github.com/GuidoPreite/DRB) - Original inspiration.
470
+ - [Power Platform ToolBox](https://www.powerplatformtoolbox.com/) — host
471
+ platform for the desktop / web app where DRS runs.
472
+ - [FetchXML Studio](https://github.com/mohsinonxrm/pptb-mxrm-fetchxml-studio) — sibling tool that pioneered many of the patterns
473
+ reused here (metadata cache, scope settings, results grid).
474
+ - [Fluent UI](https://react.fluentui.dev/) — UI component library.
475
+ - [Monaco Editor](https://microsoft.github.io/monaco-editor/) — VS Code's editor core.
476
+
477
+ ---
478
+
479
+ Built with ❤️ for the Power Platform community.