@iress-oss/ids-mcp-server 0.0.1-dev.3 → 0.0.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 (122) hide show
  1. package/LICENSE +193 -0
  2. package/README.md +159 -29
  3. package/build/componentHandlers.js +205 -0
  4. package/{dist → build}/config.js +5 -5
  5. package/build/index.js +51 -0
  6. package/{dist → build}/iressHandlers.js +46 -52
  7. package/{dist → build}/resourceHandlers.js +22 -23
  8. package/{dist → build}/searchHandlers.js +92 -107
  9. package/{dist → build}/toolHandler.js +13 -13
  10. package/build/tools.js +165 -0
  11. package/{dist → build}/utils.js +15 -11
  12. package/docs/api-reference.md +0 -0
  13. package/docs/best-practices.md +0 -0
  14. package/docs/configuration.md +0 -0
  15. package/docs/examples.md +0 -0
  16. package/docs/guidelines.md +269 -0
  17. package/{generated/docs → docs/ids}/components-autocomplete-docs.md +6 -6
  18. package/{generated/docs → docs/ids}/components-autocomplete-recipes-docs.md +51 -17
  19. package/{generated/docs → docs/ids}/components-card-recipes-docs.md +1 -1
  20. package/{generated/docs → docs/ids}/components-checkbox-docs.md +19 -6
  21. package/{generated/docs → docs/ids}/components-checkboxgroup-docs.md +18 -18
  22. package/{generated/docs → docs/ids}/components-checkboxgroup-recipes-docs.md +9 -9
  23. package/{generated/docs → docs/ids}/components-col-docs.md +1 -1
  24. package/{generated/docs → docs/ids}/components-combobox-docs.md +6 -6
  25. package/{generated/docs → docs/ids}/components-container-docs.md +42 -8
  26. package/{generated/docs → docs/ids}/components-filter-docs.md +65 -12
  27. package/{generated/docs → docs/ids}/components-form-docs.md +335 -341
  28. package/{generated/docs → docs/ids}/components-form-recipes-docs.md +1 -198
  29. package/{generated/docs → docs/ids}/components-hide-docs.md +70 -16
  30. package/{generated/docs → docs/ids}/components-icon-docs.md +4 -4
  31. package/{generated/docs → docs/ids}/components-input-recipes-docs.md +2 -2
  32. package/{generated/docs → docs/ids}/components-inputcurrency-recipes-docs.md +40 -6
  33. package/{generated/docs → docs/ids}/components-modal-docs.md +113 -3
  34. package/docs/ids/components-popover-docs.md +4 -0
  35. package/{generated/docs → docs/ids}/components-radiogroup-docs.md +21 -21
  36. package/{generated/docs → docs/ids}/components-richselect-docs.md +111 -149
  37. package/{generated/docs → docs/ids}/components-row-docs.md +4 -4
  38. package/{generated/docs → docs/ids}/components-skeleton-docs.md +3 -3
  39. package/{generated/docs → docs/ids}/components-skeleton-recipes-docs.md +1 -1
  40. package/{generated/docs → docs/ids}/components-skiplink-docs.md +1 -1
  41. package/{generated/docs → docs/ids}/components-slideout-docs.md +113 -3
  42. package/{generated/docs → docs/ids}/components-table-ag-grid-docs.md +137 -109
  43. package/{generated/docs → docs/ids}/components-table-docs.md +597 -92
  44. package/{generated/docs → docs/ids}/components-tabset-docs.md +2 -2
  45. package/{generated/docs → docs/ids}/components-tag-docs.md +1 -1
  46. package/{generated/docs → docs/ids}/components-toaster-docs.md +5 -5
  47. package/{generated/docs → docs/ids}/foundations-colours-docs.md +1 -1
  48. package/{generated/docs → docs/ids}/foundations-typography-docs.md +2 -7
  49. package/{generated/docs → docs/ids}/get-started-develop-docs.md +3 -3
  50. package/{generated/docs → docs/ids}/introduction-docs.md +4 -4
  51. package/{generated/docs → docs/ids}/patterns-loading-docs.md +2 -332
  52. package/docs/ids/resources-migration-guides-from-v4-to-v5-docs.md +639 -0
  53. package/docs/ids/themes-available-themes-docs.md +74 -0
  54. package/docs/ids/themes-tokens-docs.md +4580 -0
  55. package/docs/ids/versions-docs.md +27 -0
  56. package/docs/tutorials/basic-integration.md +0 -0
  57. package/package.json +15 -44
  58. package/LICENSE.txt +0 -201
  59. package/dist/componentHandlers.js +0 -241
  60. package/dist/componentHandlers.test.js +0 -380
  61. package/dist/index.js +0 -53
  62. package/dist/iressHandlers.test.js +0 -316
  63. package/dist/resourceHandlers.test.js +0 -352
  64. package/dist/searchHandlers.test.js +0 -524
  65. package/dist/toolHandler.test.js +0 -369
  66. package/dist/tools.js +0 -165
  67. package/dist/utils.test.js +0 -286
  68. package/generated/docs/components-popover-docs.md +0 -464
  69. package/generated/docs/foundations-accessibility-docs.md +0 -62
  70. package/generated/docs/foundations-consistency-docs.md +0 -52
  71. package/generated/docs/foundations-content-docs.md +0 -23
  72. package/generated/docs/foundations-introduction-docs.md +0 -17
  73. package/generated/docs/foundations-principles-docs.md +0 -70
  74. package/generated/docs/foundations-user-experience-docs.md +0 -63
  75. package/generated/docs/foundations-visual-design-docs.md +0 -46
  76. package/generated/docs/guidelines.md +0 -812
  77. package/generated/docs/resources-migration-guides-from-v4-to-v5-docs.md +0 -437
  78. package/generated/docs/themes-available-themes-docs.md +0 -66
  79. package/generated/docs/themes-tokens-docs.md +0 -1200
  80. package/generated/docs/versions-docs.md +0 -17
  81. /package/{dist → build}/types.js +0 -0
  82. /package/{generated/docs → docs/ids}/components-alert-docs.md +0 -0
  83. /package/{generated/docs → docs/ids}/components-badge-docs.md +0 -0
  84. /package/{generated/docs → docs/ids}/components-button-docs.md +0 -0
  85. /package/{generated/docs → docs/ids}/components-button-recipes-docs.md +0 -0
  86. /package/{generated/docs → docs/ids}/components-buttongroup-docs.md +0 -0
  87. /package/{generated/docs → docs/ids}/components-card-docs.md +0 -0
  88. /package/{generated/docs → docs/ids}/components-divider-docs.md +0 -0
  89. /package/{generated/docs → docs/ids}/components-expander-docs.md +0 -0
  90. /package/{generated/docs → docs/ids}/components-field-docs.md +0 -0
  91. /package/{generated/docs → docs/ids}/components-inline-docs.md +0 -0
  92. /package/{generated/docs → docs/ids}/components-input-docs.md +0 -0
  93. /package/{generated/docs → docs/ids}/components-inputcurrency-docs.md +0 -0
  94. /package/{generated/docs → docs/ids}/components-label-docs.md +0 -0
  95. /package/{generated/docs → docs/ids}/components-menu-docs.md +0 -0
  96. /package/{generated/docs → docs/ids}/components-menu-menuitem-docs.md +0 -0
  97. /package/{generated/docs → docs/ids}/components-navbar-docs.md +0 -0
  98. /package/{generated/docs → docs/ids}/components-navbar-recipes-docs.md +0 -0
  99. /package/{generated/docs → docs/ids}/components-panel-docs.md +0 -0
  100. /package/{generated/docs → docs/ids}/components-placeholder-docs.md +0 -0
  101. /package/{generated/docs → docs/ids}/components-popover-recipes-docs.md +0 -0
  102. /package/{generated/docs → docs/ids}/components-progress-docs.md +0 -0
  103. /package/{generated/docs → docs/ids}/components-radio-docs.md +0 -0
  104. /package/{generated/docs → docs/ids}/components-readonly-docs.md +0 -0
  105. /package/{generated/docs → docs/ids}/components-select-docs.md +0 -0
  106. /package/{generated/docs → docs/ids}/components-slider-docs.md +0 -0
  107. /package/{generated/docs → docs/ids}/components-spinner-docs.md +0 -0
  108. /package/{generated/docs → docs/ids}/components-stack-docs.md +0 -0
  109. /package/{generated/docs → docs/ids}/components-tabset-tab-docs.md +0 -0
  110. /package/{generated/docs → docs/ids}/components-text-docs.md +0 -0
  111. /package/{generated/docs → docs/ids}/components-toaster-toast-docs.md +0 -0
  112. /package/{generated/docs → docs/ids}/components-toggle-docs.md +0 -0
  113. /package/{generated/docs → docs/ids}/components-tooltip-docs.md +0 -0
  114. /package/{generated/docs → docs/ids}/components-validationmessage-docs.md +0 -0
  115. /package/{generated/docs → docs/ids}/contact-us-docs.md +0 -0
  116. /package/{generated/docs → docs/ids}/extensions-editor-docs.md +0 -0
  117. /package/{generated/docs → docs/ids}/extensions-editor-recipes-docs.md +0 -0
  118. /package/{generated/docs → docs/ids}/frequently-asked-questions-docs.md +0 -0
  119. /package/{generated/docs → docs/ids}/get-started-using-storybook-docs.md +0 -0
  120. /package/{generated/docs → docs/ids}/resources-changelog-docs.md +0 -0
  121. /package/{generated/docs → docs/ids}/resources-code-katas-docs.md +0 -0
  122. /package/{generated/docs → docs/ids}/themes-introduction-docs.md +0 -0
@@ -1,63 +0,0 @@
1
- [](#user-experience)User experience
2
- ===================================
3
-
4
- We use heuristic guidelines to assess the usability and user-centred design quality of all Iress products.
5
-
6
- [](#system-feedback)System Feedback
7
- -----------------------------------
8
-
9
- * Always show users where they are, what just happened, and what’s possible next.
10
- * Provide immediate visual and textual feedback for all actions and states.
11
- * Ensure feedback is clear, contextual, and proportionate to the importance of the action.
12
-
13
- [](#language-and-mental-models)Language and Mental Models
14
- ---------------------------------------------------------
15
-
16
- * Use user-centred language and avoid technical jargon.
17
- * Follow cultural and industry conventions for colour, iconography, terminology, and layout.
18
- * Align interaction patterns with real-world analogues wherever feasible.
19
-
20
- [](#control-and-forgiveness)Control and Forgiveness
21
- ---------------------------------------------------
22
-
23
- * Make actions reversible and provide undo where errors may occur.
24
- * Let users easily backtrack, edit inputs, or abandon flows.
25
- * Provide escape hatches from any process without penalty.
26
-
27
- [](#standards-and-consistency)Standards and Consistency
28
- -------------------------------------------------------
29
-
30
- * Use consistent layout, labelling, iconography, and grammar.
31
- * Reinforce expectations by placing similar elements in predictable positions.
32
- * Apply colour, spacing, and visual patterns consistently across all screens.
33
-
34
- [](#error-prevention-and-recovery)Error Prevention and Recovery
35
- ---------------------------------------------------------------
36
-
37
- * Prevent errors by anticipating misuse and validating early.
38
- * Phrase error messages with clarity, empathy, and constructive suggestions.
39
- * Where errors occur, explain why and how they can be resolved.
40
-
41
- [](#recognition-over-recall)Recognition Over Recall
42
- ---------------------------------------------------
43
-
44
- * Display necessary information at the point of decision.
45
- * Use visual grouping, spacing, and affordance to reveal hierarchy.
46
- * Prioritise visual clarity over novelty.
47
-
48
- [](#simplicity-and-minimalism)Simplicity and Minimalism
49
- -------------------------------------------------------
50
-
51
- * Remove unnecessary detail—every word, element, or feature should earn its place.
52
- * Design for clarity of purpose with visually distinct, semantically meaningful UI components.
53
- * Use whitespace, clean alignment, and simplified flows to reduce cognitive load.
54
-
55
- On this page
56
-
57
- * [System Feedback](#system-feedback)
58
- * [Language and Mental Models](#language-and-mental-models)
59
- * [Control and Forgiveness](#control-and-forgiveness)
60
- * [Standards and Consistency](#standards-and-consistency)
61
- * [Error Prevention and Recovery](#error-prevention-and-recovery)
62
- * [Recognition Over Recall](#recognition-over-recall)
63
- * [Simplicity and Minimalism](#simplicity-and-minimalism)
@@ -1,46 +0,0 @@
1
- [](#visual-design-standards)Visual Design Standards
2
- ===================================================
3
-
4
- [](#typography)Typography
5
- -------------------------
6
-
7
- * Use systematic font sizing with heading scales (H1-H6)
8
- * Implement consistent line heights and font weights
9
- * Provide text colour hierarchies (primary, muted, success, warning, danger)
10
- * Support responsive typography scaling
11
-
12
- [](#colour-system)Colour System
13
- -------------------------------
14
-
15
- * Maintain semantic colour meanings:
16
- * **Primary**: Main call-to-action colour with high contrast
17
- * **Success**: Positive outcomes and confirmations
18
- * **Warning**: Caution and important notices
19
- * **Danger**: Errors and destructive actions
20
- * **Info**: Neutral information and guidance
21
- * **Positive/Negative**: Financial context (buy/sell actions)
22
- * Ensure all colour combinations meet accessibility contrast requirements
23
- * Provide consistent hover and active state colours
24
-
25
- [](#spacing-and-layout)Spacing and Layout
26
- -----------------------------------------
27
-
28
- * Use systematic spacing scale (xs, sm, md, lg, xl)
29
- * Apply consistent gutter systems for layout components
30
- * Implement responsive breakpoints for adaptive layouts
31
- * Maintain proper margin and padding relationships
32
-
33
- [](#interactive-states)Interactive States
34
- -----------------------------------------
35
-
36
- * Provide clear hover, focus, active, and disabled states
37
- * Use consistent transition timing and easing
38
- * Implement proper focus indicators for keyboard navigation
39
- * Show loading states for asynchronous operations
40
-
41
- On this page
42
-
43
- * [Typography](#typography)
44
- * [Colour System](#colour-system)
45
- * [Spacing and Layout](#spacing-and-layout)
46
- * [Interactive States](#interactive-states)