@mohsinonxrm/pptb-dataverse-request-studio 1.0.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 +191 -0
- package/LICENSE +661 -0
- package/README.md +390 -0
- package/SECURITY.md +51 -0
- package/dist/assets/abap-CRCWOmpq.js +1 -0
- package/dist/assets/apex-DnsZk_dE.js +1 -0
- package/dist/assets/azcli-1IWB1ccx.js +1 -0
- package/dist/assets/bat-DPkNLes8.js +1 -0
- package/dist/assets/bicep-Corcdgou.js +2 -0
- package/dist/assets/cameligo-CGrWLZr3.js +1 -0
- package/dist/assets/clojure-D9WOWImG.js +1 -0
- package/dist/assets/codicon-B_Z2XQ3P.ttf +0 -0
- package/dist/assets/coffee-B7EJu28W.js +1 -0
- package/dist/assets/cpp-SEyurbux.js +1 -0
- package/dist/assets/csharp-BoL64M5l.js +1 -0
- package/dist/assets/csp-C46ZqvIl.js +1 -0
- package/dist/assets/css-DQU6DXDx.js +3 -0
- package/dist/assets/css.worker-CwQehIRV.js +93 -0
- package/dist/assets/cssMode-DHcTSP5p.js +4 -0
- package/dist/assets/cypher-D84EuPTj.js +1 -0
- package/dist/assets/dart-D8lhlL1r.js +1 -0
- package/dist/assets/dockerfile-DLk6rpji.js +1 -0
- package/dist/assets/ecl-BO6FnfXk.js +1 -0
- package/dist/assets/editor.worker-BTQWY0pc.js +26 -0
- package/dist/assets/elixir-BRjLKONM.js +1 -0
- package/dist/assets/flow9-Cac8vKd7.js +1 -0
- package/dist/assets/freemarker2-CY0Qd_yj.js +3 -0
- package/dist/assets/fsharp-fd1GTHhf.js +1 -0
- package/dist/assets/go-O9LJTZXk.js +1 -0
- package/dist/assets/graphql-LQdxqEYJ.js +1 -0
- package/dist/assets/handlebars-BQEEw1Ke.js +1 -0
- package/dist/assets/hcl-DxDQ3s82.js +1 -0
- package/dist/assets/html-BXibA6yW.js +1 -0
- package/dist/assets/html.worker-4xVL0wjo.js +470 -0
- package/dist/assets/htmlMode-BIOKXbRP.js +4 -0
- package/dist/assets/index-5a71OtQP.js +672 -0
- package/dist/assets/ini-BvajGCUy.js +1 -0
- package/dist/assets/java-SYsfObOQ.js +1 -0
- package/dist/assets/javascript-BY4qn0pJ.js +1 -0
- package/dist/assets/json.worker-FkK47hN5.js +58 -0
- package/dist/assets/jsonMode-BzZNqTrE.js +10 -0
- package/dist/assets/julia-DQXNmw_w.js +1 -0
- package/dist/assets/kotlin-qQ0MG-9I.js +1 -0
- package/dist/assets/less-GGFNNJHn.js +2 -0
- package/dist/assets/lexon-Canl7DCW.js +1 -0
- package/dist/assets/liquid-noPAIv1T.js +1 -0
- package/dist/assets/lua-D28Ae8-K.js +1 -0
- package/dist/assets/m3-DPitgjJI.js +1 -0
- package/dist/assets/markdown-B811l8j2.js +1 -0
- package/dist/assets/mdx-Ccyf8KqT.js +1 -0
- package/dist/assets/mips-CdjsipkG.js +1 -0
- package/dist/assets/monaco-editor-ErGqj9vD.js +901 -0
- package/dist/assets/monaco-editor-I3pIE735.css +1 -0
- package/dist/assets/msdax-CYqgjx_P.js +1 -0
- package/dist/assets/mysql-BHd6q0vd.js +1 -0
- package/dist/assets/objective-c-B1aVtJYH.js +1 -0
- package/dist/assets/pascal-BhNW15KB.js +1 -0
- package/dist/assets/pascaligo-5jv8CcQD.js +1 -0
- package/dist/assets/perl-DlYyT36c.js +1 -0
- package/dist/assets/pgsql-Dy0bjov7.js +1 -0
- package/dist/assets/php-120yhfDK.js +1 -0
- package/dist/assets/pla-CjnFlu4u.js +1 -0
- package/dist/assets/postiats-CQpG440k.js +1 -0
- package/dist/assets/powerquery-DdJtto1Z.js +1 -0
- package/dist/assets/powershell-Bu_VLpJB.js +1 -0
- package/dist/assets/protobuf-IBS6jZEB.js +2 -0
- package/dist/assets/pug-kFxLfcjb.js +1 -0
- package/dist/assets/python-CTl0fa86.js +1 -0
- package/dist/assets/qsharp-q7JyzKFN.js +1 -0
- package/dist/assets/r-BIFz-_sK.js +1 -0
- package/dist/assets/razor-DoNzFhT2.js +1 -0
- package/dist/assets/redis-CHOsPHWR.js +1 -0
- package/dist/assets/redshift-CBifECDb.js +1 -0
- package/dist/assets/restructuredtext-CghPJEOS.js +1 -0
- package/dist/assets/ruby-CYWGW-b1.js +1 -0
- package/dist/assets/rust-DMDD0SHb.js +1 -0
- package/dist/assets/sb-BYAiYHFx.js +1 -0
- package/dist/assets/scala-Bqvq8jcR.js +1 -0
- package/dist/assets/scheme-Dhb-2j9p.js +1 -0
- package/dist/assets/scss-CTwUZ5N7.js +3 -0
- package/dist/assets/shell-CsDZo4DB.js +1 -0
- package/dist/assets/solidity-CME5AdoB.js +1 -0
- package/dist/assets/sophia-RYC1BQQz.js +1 -0
- package/dist/assets/sparql-KEyrF7De.js +1 -0
- package/dist/assets/sql-BdTr02Mf.js +1 -0
- package/dist/assets/st-C7iG7M4S.js +1 -0
- package/dist/assets/swift-D7IUmUK8.js +1 -0
- package/dist/assets/systemverilog-DgMryOEJ.js +1 -0
- package/dist/assets/tcl-PloMZuKG.js +1 -0
- package/dist/assets/ts.worker-B8Ae6930.js +51330 -0
- package/dist/assets/tsMode-B1b3lx86.js +11 -0
- package/dist/assets/twig-BfRIq3la.js +1 -0
- package/dist/assets/typescript-ONTfb8eq.js +1 -0
- package/dist/assets/typespec-CzxlYoT_.js +1 -0
- package/dist/assets/vb-BwAE3J76.js +1 -0
- package/dist/assets/wgsl-Dksx_ONF.js +298 -0
- package/dist/assets/xml-6DyixHd0.js +1 -0
- package/dist/assets/yaml-B9La2-TQ.js +1 -0
- package/dist/index.html +233 -0
- package/icons/icon-insider.svg +22 -0
- package/icons/icon.svg +25 -0
- package/index.html +231 -0
- package/npm-shrinkwrap.json +3815 -0
- package/package.json +98 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to Dataverse Request Studio will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [1.0.0] - 2026-05-24
|
|
9
|
+
|
|
10
|
+
Initial public release of Dataverse Request Studio — a metadata-driven studio
|
|
11
|
+
for composing, previewing, and executing Microsoft Dataverse Web API requests
|
|
12
|
+
inside Power Platform ToolBox.
|
|
13
|
+
|
|
14
|
+
### ✨ Added
|
|
15
|
+
|
|
16
|
+
#### 📖 Read group (4 modes)
|
|
17
|
+
|
|
18
|
+
- **Retrieve Multiple** — full OData composer:
|
|
19
|
+
`$select` / `$filter` / `$orderby` / `$expand` / `$top` / `$skip` /
|
|
20
|
+
`$count` / `$apply` (groupby + aggregate). Filter tree with AND/OR
|
|
21
|
+
combinators, group nesting, NOT toggles, column-vs-column comparisons,
|
|
22
|
+
lambda `any`/`all` on collection-valued navs, and the full Dataverse
|
|
23
|
+
query-function family (`Microsoft.Dynamics.CRM.*`). Virtualized results
|
|
24
|
+
grid with infinite scroll via `@odata.nextLink`.
|
|
25
|
+
- **Retrieve Single** — by primary key OR alternate key (composite alternate
|
|
26
|
+
keys supported via `(col1='v1',col2='v2')` URL syntax).
|
|
27
|
+
- **Retrieve NextLink** — paste a server-emitted `@odata.nextLink` URL to
|
|
28
|
+
continue paging any prior query.
|
|
29
|
+
- **Predefined Query** — execute saved-query (`?savedQuery=<id>`) and
|
|
30
|
+
user-query (`?userQuery=<id>`) requests with a layout-aware results grid
|
|
31
|
+
that mirrors the source view's column order from `layoutxml`.
|
|
32
|
+
|
|
33
|
+
#### ✏️ Write group (5 modes)
|
|
34
|
+
|
|
35
|
+
- **Create Record** — `POST /<set>` with metadata-driven `FieldSetEditor`,
|
|
36
|
+
required-field guard, `Prefer: return=representation` toggle, return-set
|
|
37
|
+
`$select`, Form ↔ JSON body-mode switcher (Monaco editor for JSON edits),
|
|
38
|
+
and the `MSCRM.*` bypass-header family.
|
|
39
|
+
- **Update Record** — `PATCH /<set>(<id>)` multi-field OR `PUT /<set>(<id>)/<col>`
|
|
40
|
+
single-column. Diff view (before → after) with per-row drill-down that
|
|
41
|
+
flips the method pill from PATCH to PUT automatically.
|
|
42
|
+
- **Upsert Record** — full upsert / create-only / update-only / etag-guarded
|
|
43
|
+
variants. By GUID OR alternate key.
|
|
44
|
+
- **Delete Record** — `DELETE /<set>(<id>)` with a typed-confirmation safety
|
|
45
|
+
affordance + cascade-impact preview. Single-property delete via
|
|
46
|
+
`DELETE /<set>(<id>)/<col>` and `PUT /<set>(<id>)/<col>` with `{"value": null}`
|
|
47
|
+
also supported.
|
|
48
|
+
- **Merge Records** — `POST /Merge` for `account` / `contact` / `incident`
|
|
49
|
+
with target + subordinate record cards, field-override matrix, and
|
|
50
|
+
PerformParentingChecks / SuppressDuplicateDetection settings.
|
|
51
|
+
|
|
52
|
+
#### 🔗 Relate group (2 modes)
|
|
53
|
+
|
|
54
|
+
- **Associate** — collection-valued `POST /<set>(<id>)/<nav>/$ref` OR
|
|
55
|
+
single-valued `PATCH @odata.bind`. Cardinality detected from metadata; verb
|
|
56
|
+
auto-flips with the nav picker. Polymorphic lookups (Customer, Owner,
|
|
57
|
+
`regardingobjectid`) emit the correct target-disambiguated
|
|
58
|
+
`<navName>@odata.bind` binding shape.
|
|
59
|
+
- **Disassociate** — collection-valued `DELETE /<set>(<id>)/<nav>(<targetId>)/$ref`
|
|
60
|
+
OR single-valued `PATCH @odata.bind: null`. Same polymorphism story.
|
|
61
|
+
|
|
62
|
+
#### ⚡ Execute group (3 modes)
|
|
63
|
+
|
|
64
|
+
- **Execute Action** — OOB / Custom API / Custom Action invocation via
|
|
65
|
+
bound `POST /<set>(<id>)/Microsoft.Dynamics.CRM.<Action>` OR unbound
|
|
66
|
+
`POST /<Action>`. CSDL-driven parameter form with type-aware controls:
|
|
67
|
+
EntityReference (record picker), EntityCollection (multi-record picker),
|
|
68
|
+
Edm primitives (typed inputs), Enum / Status-code OptionSet (live-resolved
|
|
69
|
+
picker), ComplexType (nested form). Required-first UX with optional params
|
|
70
|
+
collapsed into an Accordion; Form ↔ JSON toggle via Monaco; Request body
|
|
71
|
+
preview card.
|
|
72
|
+
- **Execute Function** — OData function calls with `?@p1=...` parameter
|
|
73
|
+
aliasing OR inline literal encoding. Colorized URL preview. Same
|
|
74
|
+
type-aware controls as actions.
|
|
75
|
+
- **Execute Workflow** — runs on-demand workflows via
|
|
76
|
+
`POST /workflows(<id>)/Microsoft.Dynamics.CRM.ExecuteWorkflow` with the
|
|
77
|
+
bound record id. Live picker over activated, on-demand process workflows
|
|
78
|
+
(`statecode eq 1 and type eq 1 and ondemand eq true and category eq 0`).
|
|
79
|
+
|
|
80
|
+
#### 💾 Binary group (3 modes)
|
|
81
|
+
|
|
82
|
+
- **Manage File Data** — File-column upload / download / delete pipelines:
|
|
83
|
+
- 3 upload paths — single-request `PATCH /<set>(<id>)/<col>` with
|
|
84
|
+
`x-ms-file-name` header, chunked PATCH with session token in `Location`
|
|
85
|
+
response, or `InitializeFileBlocksUpload` / `UploadBlock` /
|
|
86
|
+
`CommitFileBlocksUpload` messages.
|
|
87
|
+
- 4 download paths — single GET `/$value`, ranged GET with `Range` header,
|
|
88
|
+
message-based block download via `InitializeFileBlocksDownload` /
|
|
89
|
+
`DownloadBlock`, or `GetFileSasUrl` function for SAS-URL handoff.
|
|
90
|
+
- Delete via `DELETE /<set>(<id>)/<col>` OR `POST /DeleteFile {FileId}`.
|
|
91
|
+
- **Manage Image Data** — Image columns with thumbnail vs full-size download
|
|
92
|
+
(`?size=full`), `CanStoreFullImage` awareness, and explicit pointers to
|
|
93
|
+
the file-column messages path for full-size uploads. Three doc-equivalent
|
|
94
|
+
delete forms (DELETE, PATCH-to-null, PUT-with-null).
|
|
95
|
+
- **Manage Attachment / Note** — `activitymimeattachment.body` and
|
|
96
|
+
`annotation.documentbody`. Inline base 64 (≲ 4 MB) OR
|
|
97
|
+
`Initialize{Attachment|Annotation}BlocksUpload` /
|
|
98
|
+
`Commit{Attachment|Annotation}BlocksUpload` messages. Single-request
|
|
99
|
+
GET `/$value` OR message-based block download.
|
|
100
|
+
|
|
101
|
+
#### 🔍 Cross-cutting capabilities
|
|
102
|
+
|
|
103
|
+
- **Live Dataverse metadata** — tables, columns, relationships, alternate
|
|
104
|
+
keys, action / function CSDL all fetched lazily from the host's
|
|
105
|
+
`dataverseAPI`. Singleton TTL cache (5-minute TTL) with in-flight promise
|
|
106
|
+
dedup. Type-specific column properties (Targets, OptionSet, MaxLength,
|
|
107
|
+
MinValue / MaxValue, Format) loaded on-demand per column.
|
|
108
|
+
- **Antipattern advisories** — real-time guidance per the Microsoft
|
|
109
|
+
query-antipatterns doc: `FilteringOnCalculatedColumns`,
|
|
110
|
+
`LargeAmountOfLogicalAttributes`, large-text `contains`, leading-wildcard
|
|
111
|
+
rewrites. Surfaces inline at the source AND aggregates into an Advisory
|
|
112
|
+
drawer in the URL bar.
|
|
113
|
+
- **Polymorphic lookup support** — Customer, Owner, and multi-target
|
|
114
|
+
lookups (`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), `fetch`,
|
|
118
|
+
`curl`, and PowerShell `Invoke-RestMethod` snippets. Multi-request
|
|
119
|
+
pipelines (chunked uploads, message-based binary ops) render as full
|
|
120
|
+
ordered sequences in the Code tab.
|
|
121
|
+
- **Saved-request library** — per-org localStorage persistence (50-entry
|
|
122
|
+
cap per org), auto-suggested names, rename / delete / overwrite, dirty-state
|
|
123
|
+
detection. Cross-tab sync via `storage` event listener.
|
|
124
|
+
- **Results grid** — virtualized via `@fluentui-contrib/react-data-grid-react-window`
|
|
125
|
+
for smooth scrolling of large result sets. Per-AttributeTypeCode cell
|
|
126
|
+
renderers (Switch for Boolean, Badge for Picklist / Status, lookup
|
|
127
|
+
formatted-value rendering, locale-formatted dates / numbers / money).
|
|
128
|
+
Sort indicators driven by `$orderby` state. Search bar + density toggle.
|
|
129
|
+
Infinite scroll fires `onLoadMore` 10 rows from the bottom; Retrieve-All
|
|
130
|
+
walks every page until exhausted.
|
|
131
|
+
- **PPTB host integration** — `isEmbedded()`-aware UI: theme syncs with the
|
|
132
|
+
host, environment-aware URLs resolve via `getSession().environmentUrl`,
|
|
133
|
+
header / theme controls hide when the host owns them. Bypass headers
|
|
134
|
+
surface in the Code tab for external execution.
|
|
135
|
+
- **Standalone mode** — runs in a regular browser via `npm run dev`. Execute
|
|
136
|
+
returns `501 Not Implemented` (no host bridge), but the URL bar, body
|
|
137
|
+
preview, and Code tab work end-to-end.
|
|
138
|
+
|
|
139
|
+
#### 🎨 UX
|
|
140
|
+
|
|
141
|
+
- **Required-first parameter UX** — required action params / required
|
|
142
|
+
create columns surface in the main pane; optional params collapse into
|
|
143
|
+
an Accordion with a "N of M set" badge.
|
|
144
|
+
- **Two-dropdown cascading picker** — Scope (group / bound entity) +
|
|
145
|
+
Operation for Execute modes. Picking a scope filters the operation list;
|
|
146
|
+
scope change cascades-resets the operation.
|
|
147
|
+
- **Form ↔ JSON toggle** — Monaco-backed JSON editor for action params and
|
|
148
|
+
create / update bodies. Two-way live sync via `setValues` so edits in JSON
|
|
149
|
+
reflect in the form and vice versa.
|
|
150
|
+
- **Diff view in Update mode** — fetches the current record on entry,
|
|
151
|
+
shows changed rows (before → after) with color coding, unchanged rows
|
|
152
|
+
collapsed under a "Show unchanged" toggle.
|
|
153
|
+
- **Operation-specific result narratives** — `WriteResultCard` renders
|
|
154
|
+
per-operation success / failure copy (Create returns 204 with
|
|
155
|
+
`OData-EntityId`; Delete returns 204; binary ops return 501 framed as
|
|
156
|
+
"request built, run externally"; ETag-stale 412 has its own narrative).
|
|
157
|
+
- **Sidebar with clause tree** — every mode has the same shell: target
|
|
158
|
+
pane on the left, active editor in the center, URL bar + Execute on the
|
|
159
|
+
bottom. Sections expand into clause sub-items with dirty markers.
|
|
160
|
+
- **Theme support** — light + dark via Fluent v9 themes, with studio-owned
|
|
161
|
+
CSS variables for brand / method palettes. Group-color cascade overrides
|
|
162
|
+
Fluent's brand tokens per mode group (Read = blue, Write = green,
|
|
163
|
+
Relate = purple, Execute = orange, Binary = brown-red).
|
|
164
|
+
|
|
165
|
+
### 🏗️ Technical
|
|
166
|
+
|
|
167
|
+
- **TypeScript strict mode** — zero `any` (with eslint-escape-hatched
|
|
168
|
+
exceptions documented inline). Discriminated unions for `ColumnMeta`,
|
|
169
|
+
`FileUploadMethod`, `Advisory`, every clause node type.
|
|
170
|
+
- **Vite 7** — production build splits Monaco into its own chunk
|
|
171
|
+
(~3.7 MB on disk, lazy-loaded on Code-tab open). Main bundle ~1.87 MB
|
|
172
|
+
raw / 494 KB gzipped.
|
|
173
|
+
- **Fluent UI v9 (9.73)** — no v8 / v0 fallbacks. Custom `triggerButton`
|
|
174
|
+
styling for `NavPathColumnPicker` uses `!important` over Fluent tokens
|
|
175
|
+
to defeat the appearance-variant specificity in dark mode.
|
|
176
|
+
- **`@pptb/types` 1.2.1** — official Power Platform ToolBox type
|
|
177
|
+
definitions; `features.minAPI: "1.2.0"` in the manifest pins the
|
|
178
|
+
required host version.
|
|
179
|
+
- **AGPL-3.0-only** license.
|
|
180
|
+
|
|
181
|
+
### 🔗 References
|
|
182
|
+
|
|
183
|
+
- [Use the Dataverse Web API](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/overview)
|
|
184
|
+
- [Query antipatterns](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/query-antipatterns)
|
|
185
|
+
- [File column data](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/file-column-data)
|
|
186
|
+
- [Image column data](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/image-column-data)
|
|
187
|
+
- [Attachment & Note file data](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/attachment-annotation-files)
|
|
188
|
+
- [Use Web API actions](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/use-web-api-actions)
|
|
189
|
+
- [Use Web API functions](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/use-web-api-functions)
|
|
190
|
+
- [Associate / Disassociate](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/associate-disassociate-entities-using-web-api)
|
|
191
|
+
- [Retrieve and execute predefined queries](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/webapi/retrieve-and-execute-predefined-queries)
|