@greensecurity/javascript-sdk 0.10.2 → 0.12.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.
Files changed (177) hide show
  1. package/README.md +53 -0
  2. package/bin/mcp-server.js +39429 -0
  3. package/bin/mcp-server.js.map +301 -0
  4. package/funcs/organizationsGetFacility.js +1 -1
  5. package/funcs/organizationsGetFacility.js.map +1 -1
  6. package/funcs/organizationsListOrSearchFacilities.js +1 -1
  7. package/funcs/organizationsListOrSearchFacilities.js.map +1 -1
  8. package/funcs/userGetCurrentUser.js +1 -1
  9. package/funcs/userGetCurrentUser.js.map +1 -1
  10. package/funcs/userGetUserById.js +1 -1
  11. package/funcs/userGetUserById.js.map +1 -1
  12. package/funcs/userLogsUserIntoTheSystem.js +1 -1
  13. package/funcs/userLogsUserIntoTheSystem.js.map +1 -1
  14. package/funcs/userMagiclink.js +1 -1
  15. package/funcs/userMagiclink.js.map +1 -1
  16. package/funcs/userPassword.js +1 -1
  17. package/funcs/userPassword.js.map +1 -1
  18. package/funcs/userPasswordResetRequest.js +1 -1
  19. package/funcs/userPasswordResetRequest.js.map +1 -1
  20. package/funcs/vendorsCreateVendorRegistration.js +1 -1
  21. package/funcs/vendorsCreateVendorRegistration.js.map +1 -1
  22. package/funcs/vendorsListVendorJobTitles.js +1 -1
  23. package/funcs/vendorsListVendorJobTitles.js.map +1 -1
  24. package/jsr.json +1 -1
  25. package/lib/config.d.ts +6 -6
  26. package/lib/config.d.ts.map +1 -1
  27. package/lib/config.js +3 -3
  28. package/lib/config.js.map +1 -1
  29. package/lib/files.js.map +1 -1
  30. package/lib/primitives.d.ts +3 -0
  31. package/lib/primitives.d.ts.map +1 -1
  32. package/lib/primitives.js +7 -0
  33. package/lib/primitives.js.map +1 -1
  34. package/mcp-server/build.d.mts.map +1 -0
  35. package/mcp-server/build.mjs +14 -0
  36. package/mcp-server/build.mjs.map +1 -0
  37. package/mcp-server/cli/start/command.d.ts +2 -0
  38. package/mcp-server/cli/start/command.d.ts.map +1 -0
  39. package/mcp-server/cli/start/command.js +137 -0
  40. package/mcp-server/cli/start/command.js.map +1 -0
  41. package/mcp-server/cli/start/impl.d.ts +18 -0
  42. package/mcp-server/cli/start/impl.d.ts.map +1 -0
  43. package/mcp-server/cli/start/impl.js +102 -0
  44. package/mcp-server/cli/start/impl.js.map +1 -0
  45. package/mcp-server/cli.d.ts +6 -0
  46. package/mcp-server/cli.d.ts.map +1 -0
  47. package/mcp-server/cli.js +10 -0
  48. package/mcp-server/cli.js.map +1 -0
  49. package/mcp-server/console-logger.d.ts +7 -0
  50. package/mcp-server/console-logger.d.ts.map +1 -0
  51. package/mcp-server/console-logger.js +59 -0
  52. package/mcp-server/console-logger.js.map +1 -0
  53. package/mcp-server/mcp-server.d.ts +2 -0
  54. package/mcp-server/mcp-server.d.ts.map +1 -0
  55. package/mcp-server/mcp-server.js +29 -0
  56. package/mcp-server/mcp-server.js.map +1 -0
  57. package/mcp-server/resources.d.ts +27 -0
  58. package/mcp-server/resources.d.ts.map +1 -0
  59. package/mcp-server/resources.js +51 -0
  60. package/mcp-server/resources.js.map +1 -0
  61. package/mcp-server/scopes.d.ts +3 -0
  62. package/mcp-server/scopes.d.ts.map +1 -0
  63. package/mcp-server/scopes.js +8 -0
  64. package/mcp-server/scopes.js.map +1 -0
  65. package/mcp-server/server.d.ts +12 -0
  66. package/mcp-server/server.d.ts.map +1 -0
  67. package/mcp-server/server.js +45 -0
  68. package/mcp-server/server.js.map +1 -0
  69. package/mcp-server/shared.d.ts +7 -0
  70. package/mcp-server/shared.d.ts.map +1 -0
  71. package/mcp-server/shared.js +98 -0
  72. package/mcp-server/shared.js.map +1 -0
  73. package/mcp-server/tools/organizationsGetFacility.d.ts +8 -0
  74. package/mcp-server/tools/organizationsGetFacility.d.ts.map +1 -0
  75. package/mcp-server/tools/organizationsGetFacility.js +64 -0
  76. package/mcp-server/tools/organizationsGetFacility.js.map +1 -0
  77. package/mcp-server/tools/organizationsListOrSearchFacilities.d.ts +8 -0
  78. package/mcp-server/tools/organizationsListOrSearchFacilities.d.ts.map +1 -0
  79. package/mcp-server/tools/organizationsListOrSearchFacilities.js +77 -0
  80. package/mcp-server/tools/organizationsListOrSearchFacilities.js.map +1 -0
  81. package/mcp-server/tools/userGetCurrentUser.d.ts +3 -0
  82. package/mcp-server/tools/userGetCurrentUser.d.ts.map +1 -0
  83. package/mcp-server/tools/userGetCurrentUser.js +26 -0
  84. package/mcp-server/tools/userGetCurrentUser.js.map +1 -0
  85. package/mcp-server/tools/userGetUserById.d.ts +8 -0
  86. package/mcp-server/tools/userGetUserById.d.ts.map +1 -0
  87. package/mcp-server/tools/userGetUserById.js +64 -0
  88. package/mcp-server/tools/userGetUserById.js.map +1 -0
  89. package/mcp-server/tools/userLogsUserIntoTheSystem.d.ts +8 -0
  90. package/mcp-server/tools/userLogsUserIntoTheSystem.d.ts.map +1 -0
  91. package/mcp-server/tools/userLogsUserIntoTheSystem.js +94 -0
  92. package/mcp-server/tools/userLogsUserIntoTheSystem.js.map +1 -0
  93. package/mcp-server/tools/userMagiclink.d.ts +8 -0
  94. package/mcp-server/tools/userMagiclink.d.ts.map +1 -0
  95. package/mcp-server/tools/userMagiclink.js +64 -0
  96. package/mcp-server/tools/userMagiclink.js.map +1 -0
  97. package/mcp-server/tools/userPassword.d.ts +8 -0
  98. package/mcp-server/tools/userPassword.d.ts.map +1 -0
  99. package/mcp-server/tools/userPassword.js +65 -0
  100. package/mcp-server/tools/userPassword.js.map +1 -0
  101. package/mcp-server/tools/userPasswordResetRequest.d.ts +8 -0
  102. package/mcp-server/tools/userPasswordResetRequest.d.ts.map +1 -0
  103. package/mcp-server/tools/userPasswordResetRequest.js +64 -0
  104. package/mcp-server/tools/userPasswordResetRequest.js.map +1 -0
  105. package/mcp-server/tools/vendorsCreateVendorRegistration.d.ts +8 -0
  106. package/mcp-server/tools/vendorsCreateVendorRegistration.d.ts.map +1 -0
  107. package/mcp-server/tools/vendorsCreateVendorRegistration.js +64 -0
  108. package/mcp-server/tools/vendorsCreateVendorRegistration.js.map +1 -0
  109. package/mcp-server/tools/vendorsListVendorJobTitles.d.ts +8 -0
  110. package/mcp-server/tools/vendorsListVendorJobTitles.d.ts.map +1 -0
  111. package/mcp-server/tools/vendorsListVendorJobTitles.js +64 -0
  112. package/mcp-server/tools/vendorsListVendorJobTitles.js.map +1 -0
  113. package/mcp-server/tools.d.ts +25 -0
  114. package/mcp-server/tools.d.ts.map +1 -0
  115. package/mcp-server/tools.js +74 -0
  116. package/mcp-server/tools.js.map +1 -0
  117. package/models/components/facility.d.ts +0 -4
  118. package/models/components/facility.d.ts.map +1 -1
  119. package/models/components/facility.js +0 -4
  120. package/models/components/facility.js.map +1 -1
  121. package/models/components/user.d.ts +6 -0
  122. package/models/components/user.d.ts.map +1 -1
  123. package/models/components/user.js +5 -0
  124. package/models/components/user.js.map +1 -1
  125. package/models/operations/password.d.ts +2 -2
  126. package/models/operations/password.d.ts.map +1 -1
  127. package/models/operations/password.js +2 -2
  128. package/models/operations/password.js.map +1 -1
  129. package/package.json +18 -2
  130. package/src/__tests__/assertions.ts +13 -0
  131. package/src/__tests__/files.ts +56 -0
  132. package/src/__tests__/organizations.test.ts +244 -0
  133. package/src/__tests__/testclient.ts +48 -0
  134. package/src/__tests__/user.test.ts +200 -0
  135. package/src/__tests__/vendors.test.ts +65 -0
  136. package/src/funcs/organizationsGetFacility.ts +1 -1
  137. package/src/funcs/organizationsListOrSearchFacilities.ts +1 -1
  138. package/src/funcs/userGetCurrentUser.ts +1 -1
  139. package/src/funcs/userGetUserById.ts +1 -1
  140. package/src/funcs/userLogsUserIntoTheSystem.ts +1 -1
  141. package/src/funcs/userMagiclink.ts +1 -1
  142. package/src/funcs/userPassword.ts +1 -1
  143. package/src/funcs/userPasswordResetRequest.ts +1 -1
  144. package/src/funcs/vendorsCreateVendorRegistration.ts +1 -1
  145. package/src/funcs/vendorsListVendorJobTitles.ts +1 -1
  146. package/src/lib/config.ts +9 -6
  147. package/src/lib/files.ts +1 -1
  148. package/src/lib/primitives.ts +14 -0
  149. package/src/mcp-server/cli/start/command.ts +106 -0
  150. package/src/mcp-server/cli/start/impl.ts +132 -0
  151. package/src/mcp-server/cli.ts +13 -0
  152. package/src/mcp-server/console-logger.ts +71 -0
  153. package/src/mcp-server/mcp-server.ts +26 -0
  154. package/src/mcp-server/resources.ts +96 -0
  155. package/src/mcp-server/scopes.ts +7 -0
  156. package/src/mcp-server/server.ts +54 -0
  157. package/src/mcp-server/shared.ts +75 -0
  158. package/src/mcp-server/tools/organizationsGetFacility.ts +37 -0
  159. package/src/mcp-server/tools/organizationsListOrSearchFacilities.ts +52 -0
  160. package/src/mcp-server/tools/userGetCurrentUser.ts +30 -0
  161. package/src/mcp-server/tools/userGetUserById.ts +37 -0
  162. package/src/mcp-server/tools/userLogsUserIntoTheSystem.ts +67 -0
  163. package/src/mcp-server/tools/userMagiclink.ts +37 -0
  164. package/src/mcp-server/tools/userPassword.ts +38 -0
  165. package/src/mcp-server/tools/userPasswordResetRequest.ts +37 -0
  166. package/src/mcp-server/tools/vendorsCreateVendorRegistration.ts +38 -0
  167. package/src/mcp-server/tools/vendorsListVendorJobTitles.ts +37 -0
  168. package/src/mcp-server/tools.ts +116 -0
  169. package/src/models/components/facility.ts +0 -8
  170. package/src/models/components/user.ts +15 -0
  171. package/src/models/operations/password.ts +4 -4
  172. package/src/vitest.config.js +5 -0
  173. package/vitest.config.d.ts +7 -0
  174. package/vitest.config.d.ts.map +1 -0
  175. package/vitest.config.js +8 -0
  176. package/vitest.config.js.map +1 -0
  177. package/vitest.config.ts +8 -0
package/README.md CHANGED
@@ -90,6 +90,59 @@ yarn add @tanstack/react-query react react-dom
90
90
  # Note that Yarn does not install peer dependencies automatically. You will need
91
91
  # to install zod as shown above.
92
92
  ```
93
+
94
+
95
+
96
+ ### Model Context Protocol (MCP) Server
97
+
98
+ This SDK is also an installable MCP server where the various SDK methods are
99
+ exposed as tools that can be invoked by AI applications.
100
+
101
+ > Node.js v20 or greater is required to run the MCP server.
102
+
103
+ <details>
104
+ <summary>Claude installation steps</summary>
105
+
106
+ Add the following server definition to your `claude_desktop_config.json` file:
107
+
108
+ ```json
109
+ {
110
+ "mcpServers": {
111
+ "GreenSecurity": {
112
+ "command": "npx",
113
+ "args": [
114
+ "-y", "--package", "@greensecurity/javascript-sdk",
115
+ "--",
116
+ "mcp", "start",
117
+ "--api-token", "...",
118
+ "--bearer-jwt", "..."
119
+ ]
120
+ }
121
+ }
122
+ }
123
+ ```
124
+
125
+ </details>
126
+
127
+ <details>
128
+ <summary>Cursor installation steps</summary>
129
+
130
+ Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
131
+
132
+ - Name: GreenSecurity
133
+ - Type: `command`
134
+ - Command:
135
+ ```sh
136
+ npx -y --package @greensecurity/javascript-sdk -- mcp start --api-token ... --bearer-jwt ...
137
+ ```
138
+
139
+ </details>
140
+
141
+ For a full list of server arguments, run:
142
+
143
+ ```sh
144
+ npx -y --package @greensecurity/javascript-sdk -- mcp start --help
145
+ ```
93
146
  <!-- End SDK Installation [installation] -->
94
147
 
95
148
  <!-- Start Requirements [requirements] -->