@drivardxrm/pptb-customapi-events-manager 1.0.2
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/LICENSE +21 -0
- package/README.md +83 -0
- package/dist/assets/index-CgrZyssv.js +1277 -0
- package/dist/assets/index-CgrZyssv.js.map +1 -0
- package/dist/assets/logo_customapi-B2Ddz3mz.png +0 -0
- package/dist/assets/powerfx-DZarVf0i.png +0 -0
- package/dist/icons/logo.svg +4 -0
- package/dist/index.html +14 -0
- package/index.html +12 -0
- package/npm-shrinkwrap.json +5057 -0
- package/package.json +89 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 David Rivard
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# Custom API & Events Manager for Power Platform ToolBox
|
|
2
|
+
|
|
3
|
+
**All-in-one workspace for creating, managing, and testing Dataverse Custom APIs and Business Events**
|
|
4
|
+
|
|
5
|
+
Designed for **Dataverse developers, solution architects, and integration builders** who need to configure, manage and explore Custom APIs and Business Event (Catalogs).
|
|
6
|
+
|
|
7
|
+
๐ **Documentation site:** https://drivardxrm.github.io/pptb-customapi-events-manager/
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## โจ Features
|
|
11
|
+
|
|
12
|
+
### Custom API Manager
|
|
13
|
+
- ๐ง **Create & Edit Custom APIs** โ Full UI for configuring Custom APIs, Request parameters and Response properties
|
|
14
|
+
- ๐ **Browse Custom Apis** โ Easily navigate Custom APIs in target environment with relevant filters
|
|
15
|
+
- ๐ข **Solution Organization** โ Create Custom APIs to solutions for governance and distribution
|
|
16
|
+
- ๐ **Tree View Display** โ Optional compact tree view layout for viewing Custom API structure
|
|
17
|
+
|
|
18
|
+
### Custom API Tester
|
|
19
|
+
- ๐งช **Execute & Test APIs** โ Call Custom APIs directly with real-time execution feedback
|
|
20
|
+
- โ๏ธ **Dynamic Parameter Input** โ Automatically generate parameter input forms based on parameter types (Boolean, DateTime, Entity selection, etc.)
|
|
21
|
+
- ๐ **Response Inspection** โ View parsed response properties with execution timing metrics
|
|
22
|
+
- ๐ **Entity Record Selection** โ For entity-bound APIs, select records from the bound entity
|
|
23
|
+
- ๐ **OData Details** โ View raw OData requests and responses
|
|
24
|
+
- โฑ๏ธ **Performance Metrics** โ Track API execution time
|
|
25
|
+
|
|
26
|
+
### Business Event Manager
|
|
27
|
+
- ๐ **Browse Event Catalog** โ Explore available Dataverse Business events (Catalogs) with relevant filters
|
|
28
|
+
- ๐ **Manage Catalogs and Assignments** โ View, create, and delete Business events (Catalogs / Catalog Assignmenents)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Settings & Configuration
|
|
32
|
+
- ๐ง **Default Publisher** โ Set default publisher for new Custom APIs and Business Events (connection-scoped)
|
|
33
|
+
- ๐ **Parameter Naming Templates** โ Customize default names for request parameters (template: `{customapiname}-In-{uniquename}`)
|
|
34
|
+
- ๐ค **Response Property Templates** โ Customize default names for response properties (template: `{customapiname}-Out-{uniquename}`)
|
|
35
|
+
- ๐ฏ **Selection Filters** โ Choose initial managed-state filters (All, Managed, Unmanaged) for Custom APIs and Business Events
|
|
36
|
+
- ๐ **Debug Toggle** โ Enable/disable Debug Mode from Settings
|
|
37
|
+
- ๐ณ **View Preferences** โ Toggle between standard and tree view layouts for Custom API details
|
|
38
|
+
|
|
39
|
+
### Debug Mode
|
|
40
|
+
- ๐ **Zustand Store Inspector** โ View real-time global application state with JSON formatting
|
|
41
|
+
- ๐ **Tanstack React Query Devtools** โ View application data with Tanstack React Query Devtools
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Quick Start
|
|
45
|
+
|
|
46
|
+
### For Power Platform Users
|
|
47
|
+
|
|
48
|
+
This tool is available in the Power Platform ToolBox marketplace. Install it directly from PPTBโno additional setup needed.
|
|
49
|
+
|
|
50
|
+
### For Developers
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npm install
|
|
54
|
+
npm run build
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The tool builds as a single-file bundle optimized for Power Platform ToolBox integration.
|
|
58
|
+
|
|
59
|
+
#### Development
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm run dev # Local dev server with hot reload
|
|
63
|
+
npm run preview # Test the production build locally
|
|
64
|
+
npm run docs:dev # Run the VitePress documentation site locally
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Tech Stack
|
|
68
|
+
|
|
69
|
+
- **React 19** + TypeScript
|
|
70
|
+
- **Fluent UI v9** (Microsoft design system)
|
|
71
|
+
- **Zustand** (global state management)
|
|
72
|
+
- **Immer** (immutable state updates)
|
|
73
|
+
- **TanStack Query** (data fetching, mutations & async state management)
|
|
74
|
+
- **Vite** (IIFE bundler for iframe compatibility)
|
|
75
|
+
|
|
76
|
+
## Support & Feedback
|
|
77
|
+
|
|
78
|
+
- ๐ **Questions or feedback?** [Open an issue on GitHub](https://github.com/drivardxrm/pptb-customapi-events-manager/issues)
|
|
79
|
+
- ๐ **Found a bug?** [Report it here](https://github.com/drivardxrm/pptb-customapi-events-manager/issues/new)
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
MIT ยฉ David Rivard
|