@gxp-dev/tools 2.1.0 → 2.1.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gxp-dev/tools",
3
- "version": "2.1.0",
3
+ "version": "2.1.1",
4
4
  "description": "Dev tools to create platform plugins",
5
5
  "type": "commonjs",
6
6
  "publishConfig": {
@@ -685,7 +685,7 @@ async function handleAction() {
685
685
 
686
686
  onMounted(() => {
687
687
  // Listen for real-time updates
688
- store.listenSocket("primary", "DataUpdated", (eventData) => {
688
+ store.listen("primary", "DataUpdated", (eventData) => {
689
689
  data.value = eventData
690
690
  })
691
691
  })
@@ -743,11 +743,18 @@ npm run dev # HTTPS with Socket.IO
743
743
  npm run dev-http # HTTP only
744
744
 
745
745
  # Test socket events
746
- gxdev socket list # List available events
747
- gxdev socket send --event Name # Send test broadcast
746
+ gxdev socket list # List available events
747
+ gxdev socket send --event Name # Send test broadcast
748
+ gxdev socket send --event Name --identifier id # Send to a specific channel
749
+
750
+ # Dependencies
751
+ gxdev add-dependency # Interactive wizard: search endpoints and add dependency to app-manifest.json
752
+
753
+ # UIKit components
754
+ gxdev storybook # Browse components at http://localhost:6006
748
755
 
749
756
  # Lint
750
- gxdev lint --all # Validate configuration.json + app-manifest.json
757
+ gxdev lint --all # Validate configuration.json + app-manifest.json
751
758
 
752
759
  # Build for production
753
760
  gxdev build # Creates dist/ with .gxpapp package
@@ -37,7 +37,7 @@ Use the `gxp-api` MCP server to ground the implementation in the real platform
37
37
  - **Inspect a specific endpoint** — `api_get_operation_parameters`, `get_endpoint_details`.
38
38
  - **Find endpoints by payload shape** — `api_find_endpoints_by_schema` (search by request/response field names).
39
39
  - **Find WebSocket events** — `api_find_events_for_operation` (given an operationId, returns events via `x-triggered-by`), `api_list_events`, `search_websocket_events`, `get_asyncapi_spec`. Run `api_find_events_for_operation` for every operationId you plan to call so you subscribe instead of polling.
40
- - **Generate dependency JSON** — `api_generate_dependency` produces the canonical entry for `app-manifest.json` → `dependencies`.
40
+ - **Generate dependency JSON** — `api_generate_dependency` produces the canonical entry for `app-manifest.json` → `dependencies`. Alternatively, `gxdev add-dependency` runs an interactive CLI wizard that searches endpoints and writes the entry directly to `app-manifest.json`.
41
41
  - **Read the docs** — `docs_list_pages`, `docs_search`, `docs_get_page` (full-text search across docs.gxp.dev).
42
42
 
43
43
  Output of this step: a short list of the operationIds, WebSocket events, and dependencies the plugin will use.
@@ -89,7 +89,7 @@ As soon as you've added a new `store.callApi`, `store.listen`, `gxp-string`, or
89
89
  Before declaring done, exercise the plugin against real event shapes:
90
90
 
91
91
  - List available events — `gxdev socket list`.
92
- - Send one — `gxdev socket send --event <EventName>` (edit or add payloads under `socket-events/`).
92
+ - Send one — `gxdev socket send --event <EventName>` (edit or add payloads under `socket-events/`). Use `--identifier <id>` to override which channel the event fires on.
93
93
  - Hit endpoints against the local mock API via the `test_api_route` MCP tool.
94
94
  - Scaffold unit tests with `test_scaffold_component_test` for any non-trivial component.
95
95
 
@@ -452,7 +452,11 @@ Strings, assets, dependencies, colors → `additionalTabs`. Quiz/survey question
452
452
 
453
453
  Finish with `gxdev lint --all`. The linter validates both roots against the same card/field schema, so malformed questions fail in the same way malformed admin fields do.
454
454
 
455
- Available: GxButton, GxCard, GxInput, GxModal, GxSpinner, GxAlert, GxBadge, GxAvatar, GxProgress, GxTabs, GxAccordion
455
+ ## Component Kit
456
+
457
+ Use `@gxp-dev/uikit` for all UI components. Run `gxdev storybook` to browse available components and their stories at `http://localhost:6006`. When storybook is running, the `gxp-uikit-storybook` MCP server (registered in `.mcp.json`) provides tools to inspect stories, documentation, and run story tests directly from your AI assistant.
458
+
459
+ Key components: `GxButton`, `GxCard`, `GxInput`, `GxModal`, `GxSpinner`, `GxAlert`, `GxBadge`, `GxAvatar`, `GxProgress`, `GxTabs`, `GxAccordion`
456
460
 
457
461
  ## Configuration Files
458
462
 
@@ -471,9 +475,10 @@ gxdev lint --json # machine-readable output
471
475
 
472
476
  ## Testing
473
477
 
474
- - Socket events: `gxdev socket send --event EventName`
478
+ - Socket events: `gxdev socket send --event EventName` (add `--identifier <id>` to target a specific channel)
475
479
  - API calls against local mock: `test_api_route` MCP tool
476
480
  - Component tests: `test_scaffold_component_test` MCP tool
481
+ - UIKit components: `gxdev storybook` — browse components at `http://localhost:6006`
477
482
  - Dev Tools: Press Ctrl+Shift+D
478
483
  - Console: `window.gxDevTools.store()` to inspect store
479
484
 
@@ -482,6 +487,7 @@ gxdev lint --json # machine-readable output
482
487
  Set `VITE_API_ENV` in `.env`:
483
488
 
484
489
  - `mock` - Local mock server (default)
490
+ - `local` - https://dashboard.eventfinity.test
485
491
  - `develop` - https://api.zenith-develop.env.eventfinity.app
486
492
  - `staging` - https://api.efz-staging.env.eventfinity.app
487
493
  - `production` - https://api.gramercy.cloud
@@ -31,7 +31,7 @@ Ground the implementation in real platform endpoints and events. Do not invent A
31
31
  - Endpoints — `api_list_tags`, `api_list_operation_ids`, `search_api_endpoints`, `api_get_operation_parameters`, `get_endpoint_details`.
32
32
  - Find by payload shape — `api_find_endpoints_by_schema`.
33
33
  - WebSocket events — `api_find_events_for_operation` (maps operationId → events via `x-triggered-by`), `api_list_events`, `search_websocket_events`, `get_asyncapi_spec`. Run for every planned operationId so you subscribe instead of polling.
34
- - Canonical dependency JSON — `api_generate_dependency`.
34
+ - Canonical dependency JSON — `api_generate_dependency`. Or run `gxdev add-dependency` for an interactive CLI wizard that writes the entry directly to `app-manifest.json`.
35
35
  - Documentation — `docs_list_pages`, `docs_search`, `docs_get_page`.
36
36
 
37
37
  ### 3. Plan with the client
@@ -67,7 +67,7 @@ Whenever you add or change a `store.callApi`, `store.listen`, `gxp-string`, or `
67
67
  ### 6. Test broadcasts
68
68
 
69
69
  - `gxdev socket list` — see available events.
70
- - `gxdev socket send --event <EventName>` — fire a test broadcast.
70
+ - `gxdev socket send --event <EventName>` — fire a test broadcast. Add `--identifier <id>` to target a specific channel.
71
71
  - `test_api_route` MCP tool — hit endpoints against the local mock.
72
72
  - `test_scaffold_component_test` MCP tool — generate Vitest files.
73
73
 
@@ -280,7 +280,19 @@ Tools: `config_list_card_types`, `config_list_field_types`, `config_get_field_sc
280
280
 
281
281
  ## Component Kit
282
282
 
283
- Use `@gxp-dev/uikit` for UI
283
+ Use `@gxp-dev/uikit` for all UI components. Run `gxdev storybook` to browse available components at `http://localhost:6006`. When storybook is running, the `gxp-uikit-storybook` MCP server (registered in `.mcp.json`) provides tools to inspect stories and documentation.
284
+
285
+ Key components: `GxButton`, `GxCard`, `GxInput`, `GxModal`, `GxSpinner`, `GxAlert`, `GxBadge`, `GxAvatar`, `GxProgress`, `GxTabs`, `GxAccordion`
286
+
287
+ ## API Environments
288
+
289
+ Set `VITE_API_ENV` in `.env`:
290
+
291
+ - `mock` - Local mock server (default)
292
+ - `local` - https://dashboard.eventfinity.test
293
+ - `develop` - https://api.zenith-develop.env.eventfinity.app
294
+ - `staging` - https://api.efz-staging.env.eventfinity.app
295
+ - `production` - https://api.gramercy.cloud
284
296
 
285
297
  ## API Specs
286
298