@strapi/plugin-documentation 0.0.0-experimental.62ebf57bb35846666febb5ee2078fe02fe990f57 → 0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282

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 (500) hide show
  1. package/README.md +2 -3
  2. package/dist/admin/components/SettingsForm.js +203 -0
  3. package/dist/admin/components/SettingsForm.js.map +1 -0
  4. package/dist/admin/components/SettingsForm.mjs +180 -0
  5. package/dist/admin/components/SettingsForm.mjs.map +1 -0
  6. package/dist/admin/constants.js +47 -0
  7. package/dist/admin/constants.js.map +1 -0
  8. package/dist/admin/constants.mjs +45 -0
  9. package/dist/admin/constants.mjs.map +1 -0
  10. package/dist/admin/index.js +96 -5
  11. package/dist/admin/index.js.map +1 -1
  12. package/dist/admin/index.mjs +91 -5
  13. package/dist/admin/index.mjs.map +1 -1
  14. package/dist/admin/pages/App.js +254 -0
  15. package/dist/admin/pages/App.js.map +1 -0
  16. package/dist/admin/pages/App.mjs +232 -0
  17. package/dist/admin/pages/App.mjs.map +1 -0
  18. package/dist/admin/pages/Settings.js +54 -0
  19. package/dist/admin/pages/Settings.js.map +1 -0
  20. package/dist/admin/pages/Settings.mjs +52 -0
  21. package/dist/admin/pages/Settings.mjs.map +1 -0
  22. package/dist/admin/pluginId.js +6 -0
  23. package/dist/admin/pluginId.js.map +1 -0
  24. package/dist/admin/pluginId.mjs +4 -0
  25. package/dist/admin/pluginId.mjs.map +1 -0
  26. package/dist/admin/services/api.js +55 -0
  27. package/dist/admin/services/api.js.map +1 -0
  28. package/dist/admin/services/api.mjs +50 -0
  29. package/dist/admin/services/api.mjs.map +1 -0
  30. package/dist/admin/src/components/SettingsForm.d.ts +8 -0
  31. package/dist/admin/src/constants.d.ts +18 -0
  32. package/dist/admin/src/index.d.ts +15 -0
  33. package/dist/admin/src/pages/App.d.ts +2 -0
  34. package/dist/admin/src/pages/Settings.d.ts +2 -0
  35. package/dist/admin/src/pages/tests/App.test.d.ts +1 -0
  36. package/dist/admin/src/pages/tests/Settings.test.d.ts +1 -0
  37. package/dist/admin/src/pluginId.d.ts +1 -0
  38. package/dist/admin/src/services/api.d.ts +13 -0
  39. package/dist/admin/src/types.d.ts +16 -0
  40. package/dist/admin/src/utils/baseQuery.d.ts +5 -0
  41. package/dist/admin/src/utils/getTrad.d.ts +1 -0
  42. package/dist/admin/src/utils/index.d.ts +2 -0
  43. package/dist/admin/src/utils/prefixPluginTranslations.d.ts +2 -0
  44. package/dist/admin/translations/ar.json.js +25 -0
  45. package/dist/admin/translations/ar.json.js.map +1 -0
  46. package/dist/admin/translations/ar.json.mjs +23 -0
  47. package/dist/admin/translations/ar.json.mjs.map +1 -0
  48. package/dist/admin/translations/cs.json.js +47 -0
  49. package/dist/admin/translations/cs.json.js.map +1 -0
  50. package/dist/admin/translations/cs.json.mjs +45 -0
  51. package/dist/admin/translations/cs.json.mjs.map +1 -0
  52. package/dist/admin/translations/da.json.js +44 -0
  53. package/dist/admin/translations/da.json.js.map +1 -0
  54. package/dist/admin/translations/da.json.mjs +42 -0
  55. package/dist/admin/translations/da.json.mjs.map +1 -0
  56. package/dist/admin/translations/de.json.js +47 -0
  57. package/dist/admin/translations/de.json.js.map +1 -0
  58. package/dist/admin/translations/de.json.mjs +45 -0
  59. package/dist/admin/translations/de.json.mjs.map +1 -0
  60. package/dist/admin/translations/en.json.js +47 -0
  61. package/dist/admin/translations/en.json.js.map +1 -0
  62. package/dist/admin/translations/en.json.mjs +45 -0
  63. package/dist/admin/translations/en.json.mjs.map +1 -0
  64. package/dist/admin/translations/es.json.js +47 -0
  65. package/dist/admin/translations/es.json.js.map +1 -0
  66. package/dist/admin/translations/es.json.mjs +45 -0
  67. package/dist/admin/translations/es.json.mjs.map +1 -0
  68. package/dist/admin/translations/fr.json.js +31 -0
  69. package/dist/admin/translations/fr.json.js.map +1 -0
  70. package/dist/admin/translations/fr.json.mjs +29 -0
  71. package/dist/admin/translations/fr.json.mjs.map +1 -0
  72. package/dist/admin/translations/id.json.js +29 -0
  73. package/dist/admin/translations/id.json.js.map +1 -0
  74. package/dist/admin/translations/id.json.mjs +27 -0
  75. package/dist/admin/translations/id.json.mjs.map +1 -0
  76. package/dist/admin/translations/it.json.js +31 -0
  77. package/dist/admin/translations/it.json.js.map +1 -0
  78. package/dist/admin/translations/it.json.mjs +29 -0
  79. package/dist/admin/translations/it.json.mjs.map +1 -0
  80. package/dist/admin/translations/ko.json.js +44 -0
  81. package/dist/admin/translations/ko.json.js.map +1 -0
  82. package/dist/admin/translations/ko.json.mjs +42 -0
  83. package/dist/admin/translations/ko.json.mjs.map +1 -0
  84. package/dist/admin/translations/ms.json.js +28 -0
  85. package/dist/admin/translations/ms.json.js.map +1 -0
  86. package/dist/admin/translations/ms.json.mjs +26 -0
  87. package/dist/admin/translations/ms.json.mjs.map +1 -0
  88. package/dist/admin/translations/nl.json.js +26 -0
  89. package/dist/admin/translations/nl.json.js.map +1 -0
  90. package/dist/admin/translations/nl.json.mjs +24 -0
  91. package/dist/admin/translations/nl.json.mjs.map +1 -0
  92. package/dist/admin/translations/pl.json.js +47 -0
  93. package/dist/admin/translations/pl.json.js.map +1 -0
  94. package/dist/admin/translations/pl.json.mjs +45 -0
  95. package/dist/admin/translations/pl.json.mjs.map +1 -0
  96. package/dist/admin/translations/pt-BR.json.js +26 -0
  97. package/dist/admin/translations/pt-BR.json.js.map +1 -0
  98. package/dist/admin/translations/pt-BR.json.mjs +24 -0
  99. package/dist/admin/translations/pt-BR.json.mjs.map +1 -0
  100. package/dist/admin/translations/pt.json.js +26 -0
  101. package/dist/admin/translations/pt.json.js.map +1 -0
  102. package/dist/admin/translations/pt.json.mjs +24 -0
  103. package/dist/admin/translations/pt.json.mjs.map +1 -0
  104. package/dist/admin/translations/ru.json.js +47 -0
  105. package/dist/admin/translations/ru.json.js.map +1 -0
  106. package/dist/admin/translations/ru.json.mjs +45 -0
  107. package/dist/admin/translations/ru.json.mjs.map +1 -0
  108. package/dist/admin/translations/sk.json.js +47 -0
  109. package/dist/admin/translations/sk.json.js.map +1 -0
  110. package/dist/admin/translations/sk.json.mjs +45 -0
  111. package/dist/admin/translations/sk.json.mjs.map +1 -0
  112. package/dist/admin/translations/sv.json.js +44 -0
  113. package/dist/admin/translations/sv.json.js.map +1 -0
  114. package/dist/admin/translations/sv.json.mjs +42 -0
  115. package/dist/admin/translations/sv.json.mjs.map +1 -0
  116. package/dist/admin/translations/th.json.js +29 -0
  117. package/dist/admin/translations/th.json.js.map +1 -0
  118. package/dist/admin/translations/th.json.mjs +27 -0
  119. package/dist/admin/translations/th.json.mjs.map +1 -0
  120. package/dist/admin/translations/tr.json.js +44 -0
  121. package/dist/admin/translations/tr.json.js.map +1 -0
  122. package/dist/admin/translations/tr.json.mjs +42 -0
  123. package/dist/admin/translations/tr.json.mjs.map +1 -0
  124. package/dist/admin/translations/uk.json.js +47 -0
  125. package/dist/admin/translations/uk.json.js.map +1 -0
  126. package/dist/admin/translations/uk.json.mjs +45 -0
  127. package/dist/admin/translations/uk.json.mjs.map +1 -0
  128. package/dist/admin/translations/vi.json.js +29 -0
  129. package/dist/admin/translations/vi.json.js.map +1 -0
  130. package/dist/admin/translations/vi.json.mjs +27 -0
  131. package/dist/admin/translations/vi.json.mjs.map +1 -0
  132. package/dist/admin/translations/zh-Hans.json.js +33 -0
  133. package/dist/admin/translations/zh-Hans.json.js.map +1 -0
  134. package/dist/admin/translations/zh-Hans.json.mjs +31 -0
  135. package/dist/admin/translations/zh-Hans.json.mjs.map +1 -0
  136. package/dist/admin/translations/zh.json.js +44 -0
  137. package/dist/admin/translations/zh.json.js.map +1 -0
  138. package/dist/admin/translations/zh.json.mjs +42 -0
  139. package/dist/admin/translations/zh.json.mjs.map +1 -0
  140. package/dist/admin/utils/baseQuery.js +8 -0
  141. package/dist/admin/utils/baseQuery.js.map +1 -0
  142. package/dist/admin/utils/baseQuery.mjs +6 -0
  143. package/dist/admin/utils/baseQuery.mjs.map +1 -0
  144. package/dist/admin/utils/getTrad.js +8 -0
  145. package/dist/admin/utils/getTrad.js.map +1 -0
  146. package/dist/admin/utils/getTrad.mjs +6 -0
  147. package/dist/admin/utils/getTrad.mjs.map +1 -0
  148. package/dist/admin/utils/prefixPluginTranslations.js +11 -0
  149. package/dist/admin/utils/prefixPluginTranslations.js.map +1 -0
  150. package/dist/admin/utils/prefixPluginTranslations.mjs +9 -0
  151. package/dist/admin/utils/prefixPluginTranslations.mjs.map +1 -0
  152. package/dist/server/bootstrap.js +57 -0
  153. package/dist/server/bootstrap.js.map +1 -0
  154. package/dist/server/bootstrap.mjs +55 -0
  155. package/dist/server/bootstrap.mjs.map +1 -0
  156. package/dist/server/config/default-plugin-config.js +88 -0
  157. package/dist/server/config/default-plugin-config.js.map +1 -0
  158. package/dist/server/config/default-plugin-config.mjs +86 -0
  159. package/dist/server/config/default-plugin-config.mjs.map +1 -0
  160. package/dist/server/config/index.js +10 -0
  161. package/dist/server/config/index.js.map +1 -0
  162. package/dist/server/config/index.mjs +8 -0
  163. package/dist/server/config/index.mjs.map +1 -0
  164. package/dist/server/controllers/documentation.js +194 -0
  165. package/dist/server/controllers/documentation.js.map +1 -0
  166. package/dist/server/controllers/documentation.mjs +182 -0
  167. package/dist/server/controllers/documentation.mjs.map +1 -0
  168. package/dist/server/controllers/index.js +10 -0
  169. package/dist/server/controllers/index.js.map +1 -0
  170. package/dist/server/controllers/index.mjs +8 -0
  171. package/dist/server/controllers/index.mjs.map +1 -0
  172. package/dist/server/index.js +20 -0
  173. package/dist/server/index.js.map +1 -0
  174. package/dist/server/index.mjs +18 -0
  175. package/dist/server/index.mjs.map +1 -0
  176. package/dist/server/middlewares/documentation.js +33 -0
  177. package/dist/server/middlewares/documentation.js.map +1 -0
  178. package/dist/server/middlewares/documentation.mjs +25 -0
  179. package/dist/server/middlewares/documentation.mjs.map +1 -0
  180. package/dist/server/middlewares/restrict-access.js +23 -0
  181. package/dist/server/middlewares/restrict-access.js.map +1 -0
  182. package/dist/server/middlewares/restrict-access.mjs +21 -0
  183. package/dist/server/middlewares/restrict-access.mjs.map +1 -0
  184. package/dist/server/public/index.html.js +6 -0
  185. package/dist/server/public/index.html.js.map +1 -0
  186. package/dist/server/public/index.html.mjs +4 -0
  187. package/dist/server/public/index.html.mjs.map +1 -0
  188. package/dist/server/public/login.html.js +6 -0
  189. package/dist/server/public/login.html.js.map +1 -0
  190. package/dist/server/public/login.html.mjs +4 -0
  191. package/dist/server/public/login.html.mjs.map +1 -0
  192. package/dist/server/register.js +12 -0
  193. package/dist/server/register.js.map +1 -0
  194. package/dist/server/register.mjs +10 -0
  195. package/dist/server/register.mjs.map +1 -0
  196. package/dist/server/routes/index.js +106 -0
  197. package/dist/server/routes/index.js.map +1 -0
  198. package/dist/server/routes/index.mjs +104 -0
  199. package/dist/server/routes/index.mjs.map +1 -0
  200. package/dist/server/services/documentation.js +193 -0
  201. package/dist/server/services/documentation.js.map +1 -0
  202. package/dist/server/services/documentation.mjs +186 -0
  203. package/dist/server/services/documentation.mjs.map +1 -0
  204. package/dist/server/services/helpers/build-api-endpoint-path.js +166 -0
  205. package/dist/server/services/helpers/build-api-endpoint-path.js.map +1 -0
  206. package/dist/server/services/helpers/build-api-endpoint-path.mjs +141 -0
  207. package/dist/server/services/helpers/build-api-endpoint-path.mjs.map +1 -0
  208. package/dist/server/services/helpers/build-component-schema.js +178 -0
  209. package/dist/server/services/helpers/build-component-schema.js.map +1 -0
  210. package/dist/server/services/helpers/build-component-schema.mjs +172 -0
  211. package/dist/server/services/helpers/build-component-schema.mjs.map +1 -0
  212. package/dist/server/services/helpers/utils/clean-schema-attributes.js +315 -0
  213. package/dist/server/services/helpers/utils/clean-schema-attributes.js.map +1 -0
  214. package/dist/server/services/helpers/utils/clean-schema-attributes.mjs +313 -0
  215. package/dist/server/services/helpers/utils/clean-schema-attributes.mjs.map +1 -0
  216. package/dist/server/services/helpers/utils/get-api-responses.js +88 -0
  217. package/dist/server/services/helpers/utils/get-api-responses.js.map +1 -0
  218. package/dist/server/services/helpers/utils/get-api-responses.mjs +86 -0
  219. package/dist/server/services/helpers/utils/get-api-responses.mjs.map +1 -0
  220. package/dist/server/services/helpers/utils/get-schema-data.js +57 -0
  221. package/dist/server/services/helpers/utils/get-schema-data.js.map +1 -0
  222. package/dist/server/services/helpers/utils/get-schema-data.mjs +55 -0
  223. package/dist/server/services/helpers/utils/get-schema-data.mjs.map +1 -0
  224. package/dist/server/services/helpers/utils/loop-content-type-names.js +44 -0
  225. package/dist/server/services/helpers/utils/loop-content-type-names.js.map +1 -0
  226. package/dist/server/services/helpers/utils/loop-content-type-names.mjs +38 -0
  227. package/dist/server/services/helpers/utils/loop-content-type-names.mjs.map +1 -0
  228. package/dist/server/services/helpers/utils/pascal-case.js +14 -0
  229. package/dist/server/services/helpers/utils/pascal-case.js.map +1 -0
  230. package/dist/server/services/helpers/utils/pascal-case.mjs +8 -0
  231. package/dist/server/services/helpers/utils/pascal-case.mjs.map +1 -0
  232. package/dist/server/services/helpers/utils/query-params.js +109 -0
  233. package/dist/server/services/helpers/utils/query-params.js.map +1 -0
  234. package/dist/server/services/helpers/utils/query-params.mjs +107 -0
  235. package/dist/server/services/helpers/utils/query-params.mjs.map +1 -0
  236. package/dist/server/services/helpers/utils/routes.js +11 -0
  237. package/dist/server/services/helpers/utils/routes.js.map +1 -0
  238. package/dist/server/services/helpers/utils/routes.mjs +9 -0
  239. package/dist/server/services/helpers/utils/routes.mjs.map +1 -0
  240. package/dist/server/services/index.js +13 -0
  241. package/dist/server/services/index.js.map +1 -0
  242. package/dist/server/services/index.mjs +11 -0
  243. package/dist/server/services/index.mjs.map +1 -0
  244. package/dist/server/services/override.js +45 -0
  245. package/dist/server/services/override.js.map +1 -0
  246. package/dist/server/services/override.mjs +43 -0
  247. package/dist/server/services/override.mjs.map +1 -0
  248. package/dist/server/services/utils/get-plugins-that-need-documentation.js +24 -0
  249. package/dist/server/services/utils/get-plugins-that-need-documentation.js.map +1 -0
  250. package/dist/server/services/utils/get-plugins-that-need-documentation.mjs +22 -0
  251. package/dist/server/services/utils/get-plugins-that-need-documentation.mjs.map +1 -0
  252. package/dist/server/src/bootstrap.d.ts +5 -0
  253. package/dist/server/src/bootstrap.d.ts.map +1 -0
  254. package/dist/server/src/config/default-plugin-config.d.ts +3 -0
  255. package/dist/server/src/config/default-plugin-config.d.ts.map +1 -0
  256. package/dist/server/src/config/index.d.ts +4 -0
  257. package/dist/server/src/config/index.d.ts.map +1 -0
  258. package/dist/server/src/controllers/documentation.d.ts +12 -0
  259. package/dist/server/src/controllers/documentation.d.ts.map +1 -0
  260. package/dist/server/src/controllers/index.d.ts +13 -0
  261. package/dist/server/src/controllers/index.d.ts.map +1 -0
  262. package/dist/server/src/index.d.ts +90 -0
  263. package/dist/server/src/index.d.ts.map +1 -0
  264. package/dist/server/src/middlewares/documentation.d.ts +5 -0
  265. package/dist/server/src/middlewares/documentation.d.ts.map +1 -0
  266. package/dist/server/src/middlewares/restrict-access.d.ts +4 -0
  267. package/dist/server/src/middlewares/restrict-access.d.ts.map +1 -0
  268. package/dist/server/src/register.d.ts +5 -0
  269. package/dist/server/src/register.d.ts.map +1 -0
  270. package/dist/server/src/routes/index.d.ts +35 -0
  271. package/dist/server/src/routes/index.d.ts.map +1 -0
  272. package/dist/server/src/services/__mocks__/mock-content-types.d.ts +449 -0
  273. package/dist/server/src/services/__mocks__/mock-content-types.d.ts.map +1 -0
  274. package/dist/server/src/services/__mocks__/mock-strapi-data.d.ts +592 -0
  275. package/dist/server/src/services/__mocks__/mock-strapi-data.d.ts.map +1 -0
  276. package/dist/server/src/services/documentation.d.ts +36 -0
  277. package/dist/server/src/services/documentation.d.ts.map +1 -0
  278. package/dist/server/src/services/helpers/build-api-endpoint-path.d.ts +7 -0
  279. package/dist/server/src/services/helpers/build-api-endpoint-path.d.ts.map +1 -0
  280. package/dist/server/src/services/helpers/build-component-schema.d.ts +4 -0
  281. package/dist/server/src/services/helpers/build-component-schema.d.ts.map +1 -0
  282. package/dist/server/src/services/helpers/index.d.ts +4 -0
  283. package/dist/server/src/services/helpers/index.d.ts.map +1 -0
  284. package/dist/server/src/services/helpers/utils/clean-schema-attributes.d.ts +15 -0
  285. package/dist/server/src/services/helpers/utils/clean-schema-attributes.d.ts.map +1 -0
  286. package/dist/server/src/services/helpers/utils/get-api-responses.d.ts +15 -0
  287. package/dist/server/src/services/helpers/utils/get-api-responses.d.ts.map +1 -0
  288. package/dist/server/src/services/helpers/utils/get-schema-data.d.ts +12 -0
  289. package/dist/server/src/services/helpers/utils/get-schema-data.d.ts.map +1 -0
  290. package/dist/server/src/services/helpers/utils/loop-content-type-names.d.ts +7 -0
  291. package/dist/server/src/services/helpers/utils/loop-content-type-names.d.ts.map +1 -0
  292. package/dist/server/src/services/helpers/utils/pascal-case.d.ts +3 -0
  293. package/dist/server/src/services/helpers/utils/pascal-case.d.ts.map +1 -0
  294. package/dist/server/src/services/helpers/utils/query-params.d.ts +4 -0
  295. package/dist/server/src/services/helpers/utils/query-params.d.ts.map +1 -0
  296. package/dist/server/src/services/helpers/utils/routes.d.ts +3 -0
  297. package/dist/server/src/services/helpers/utils/routes.d.ts.map +1 -0
  298. package/dist/server/src/services/index.d.ts +43 -0
  299. package/dist/server/src/services/index.d.ts.map +1 -0
  300. package/dist/server/src/services/override.d.ts +21 -0
  301. package/dist/server/src/services/override.d.ts.map +1 -0
  302. package/dist/server/src/services/utils/get-plugins-that-need-documentation.d.ts +4 -0
  303. package/dist/server/src/services/utils/get-plugins-that-need-documentation.d.ts.map +1 -0
  304. package/dist/server/src/types.d.ts +28 -0
  305. package/dist/server/src/types.d.ts.map +1 -0
  306. package/dist/server/src/utils.d.ts +12 -0
  307. package/dist/server/src/utils.d.ts.map +1 -0
  308. package/dist/server/utils.js +10 -0
  309. package/dist/server/utils.js.map +1 -0
  310. package/dist/server/utils.mjs +8 -0
  311. package/dist/server/utils.mjs.map +1 -0
  312. package/dist/tests/server.d.ts +2 -0
  313. package/package.json +61 -38
  314. package/.eslintignore +0 -1
  315. package/.eslintrc +0 -17
  316. package/admin/src/constants.js +0 -17
  317. package/admin/src/hooks/useDocumentation.js +0 -77
  318. package/admin/src/index.js +0 -76
  319. package/admin/src/pages/PluginPage/index.jsx +0 -230
  320. package/admin/src/pages/PluginPage/tests/index.test.jsx +0 -206
  321. package/admin/src/pages/SettingsPage/index.jsx +0 -211
  322. package/admin/src/pages/SettingsPage/tests/index.test.jsx +0 -124
  323. package/admin/src/pluginId.js +0 -5
  324. package/admin/src/translations/ar.json +0 -20
  325. package/admin/src/translations/cs.json +0 -21
  326. package/admin/src/translations/de.json +0 -26
  327. package/admin/src/translations/dk.json +0 -39
  328. package/admin/src/translations/en.json +0 -39
  329. package/admin/src/translations/es.json +0 -39
  330. package/admin/src/translations/fr.json +0 -26
  331. package/admin/src/translations/id.json +0 -24
  332. package/admin/src/translations/it.json +0 -26
  333. package/admin/src/translations/ko.json +0 -39
  334. package/admin/src/translations/ms.json +0 -23
  335. package/admin/src/translations/nl.json +0 -21
  336. package/admin/src/translations/pl.json +0 -39
  337. package/admin/src/translations/pt-BR.json +0 -21
  338. package/admin/src/translations/pt.json +0 -21
  339. package/admin/src/translations/ru.json +0 -39
  340. package/admin/src/translations/sk.json +0 -24
  341. package/admin/src/translations/sv.json +0 -39
  342. package/admin/src/translations/th.json +0 -24
  343. package/admin/src/translations/tr.json +0 -39
  344. package/admin/src/translations/uk.json +0 -23
  345. package/admin/src/translations/vi.json +0 -24
  346. package/admin/src/translations/zh-Hans.json +0 -28
  347. package/admin/src/translations/zh.json +0 -39
  348. package/admin/src/utils/getTrad.js +0 -5
  349. package/admin/src/utils/index.js +0 -2
  350. package/dist/_chunks/ar-4yWQcJB-.js +0 -24
  351. package/dist/_chunks/ar-4yWQcJB-.js.map +0 -1
  352. package/dist/_chunks/ar-dlnabvQE.mjs +0 -24
  353. package/dist/_chunks/ar-dlnabvQE.mjs.map +0 -1
  354. package/dist/_chunks/cs-knLCHelx.js +0 -25
  355. package/dist/_chunks/cs-knLCHelx.js.map +0 -1
  356. package/dist/_chunks/cs-x2Pr-Y38.mjs +0 -25
  357. package/dist/_chunks/cs-x2Pr-Y38.mjs.map +0 -1
  358. package/dist/_chunks/de-10J3uf4y.mjs +0 -30
  359. package/dist/_chunks/de-10J3uf4y.mjs.map +0 -1
  360. package/dist/_chunks/de-D0HJjv1r.js +0 -30
  361. package/dist/_chunks/de-D0HJjv1r.js.map +0 -1
  362. package/dist/_chunks/dk-OGCIxZ4f.js +0 -43
  363. package/dist/_chunks/dk-OGCIxZ4f.js.map +0 -1
  364. package/dist/_chunks/dk-_8JEfZdj.mjs +0 -43
  365. package/dist/_chunks/dk-_8JEfZdj.mjs.map +0 -1
  366. package/dist/_chunks/en-V4ac9UMW.mjs +0 -43
  367. package/dist/_chunks/en-V4ac9UMW.mjs.map +0 -1
  368. package/dist/_chunks/en-YgFnjikD.js +0 -43
  369. package/dist/_chunks/en-YgFnjikD.js.map +0 -1
  370. package/dist/_chunks/es-5fRDaTSK.js +0 -43
  371. package/dist/_chunks/es-5fRDaTSK.js.map +0 -1
  372. package/dist/_chunks/es-f_rfLY5r.mjs +0 -43
  373. package/dist/_chunks/es-f_rfLY5r.mjs.map +0 -1
  374. package/dist/_chunks/fr-L2xRpd2l.mjs +0 -30
  375. package/dist/_chunks/fr-L2xRpd2l.mjs.map +0 -1
  376. package/dist/_chunks/fr-qviymkcR.js +0 -30
  377. package/dist/_chunks/fr-qviymkcR.js.map +0 -1
  378. package/dist/_chunks/id-caKGgafZ.js +0 -28
  379. package/dist/_chunks/id-caKGgafZ.js.map +0 -1
  380. package/dist/_chunks/id-l-r-lPDE.mjs +0 -28
  381. package/dist/_chunks/id-l-r-lPDE.mjs.map +0 -1
  382. package/dist/_chunks/index-0Psmd6mH.js +0 -169
  383. package/dist/_chunks/index-0Psmd6mH.js.map +0 -1
  384. package/dist/_chunks/index-4A--h4wV.mjs +0 -200
  385. package/dist/_chunks/index-4A--h4wV.mjs.map +0 -1
  386. package/dist/_chunks/index-4Lb4OA-2.mjs +0 -173
  387. package/dist/_chunks/index-4Lb4OA-2.mjs.map +0 -1
  388. package/dist/_chunks/index-KO2LyVtS.js +0 -199
  389. package/dist/_chunks/index-KO2LyVtS.js.map +0 -1
  390. package/dist/_chunks/index-U-tAamSt.js +0 -194
  391. package/dist/_chunks/index-U-tAamSt.js.map +0 -1
  392. package/dist/_chunks/index-rLNpelbE.mjs +0 -167
  393. package/dist/_chunks/index-rLNpelbE.mjs.map +0 -1
  394. package/dist/_chunks/it-e3T319Va.js +0 -30
  395. package/dist/_chunks/it-e3T319Va.js.map +0 -1
  396. package/dist/_chunks/it-nCSZoaet.mjs +0 -30
  397. package/dist/_chunks/it-nCSZoaet.mjs.map +0 -1
  398. package/dist/_chunks/ko-nWCOH-TF.js +0 -43
  399. package/dist/_chunks/ko-nWCOH-TF.js.map +0 -1
  400. package/dist/_chunks/ko-pUwRxmfG.mjs +0 -43
  401. package/dist/_chunks/ko-pUwRxmfG.mjs.map +0 -1
  402. package/dist/_chunks/ms-8e8SEhhY.mjs +0 -27
  403. package/dist/_chunks/ms-8e8SEhhY.mjs.map +0 -1
  404. package/dist/_chunks/ms-CSGAOmvV.js +0 -27
  405. package/dist/_chunks/ms-CSGAOmvV.js.map +0 -1
  406. package/dist/_chunks/nl-82NK6g7v.js +0 -25
  407. package/dist/_chunks/nl-82NK6g7v.js.map +0 -1
  408. package/dist/_chunks/nl-RjdbZWuM.mjs +0 -25
  409. package/dist/_chunks/nl-RjdbZWuM.mjs.map +0 -1
  410. package/dist/_chunks/pl-UMuW3iDh.js +0 -43
  411. package/dist/_chunks/pl-UMuW3iDh.js.map +0 -1
  412. package/dist/_chunks/pl-sh4sAKA8.mjs +0 -43
  413. package/dist/_chunks/pl-sh4sAKA8.mjs.map +0 -1
  414. package/dist/_chunks/pt-2sEtQifY.js +0 -25
  415. package/dist/_chunks/pt-2sEtQifY.js.map +0 -1
  416. package/dist/_chunks/pt-BR-G0-nWgFV.js +0 -25
  417. package/dist/_chunks/pt-BR-G0-nWgFV.js.map +0 -1
  418. package/dist/_chunks/pt-BR-uX3O_t0X.mjs +0 -25
  419. package/dist/_chunks/pt-BR-uX3O_t0X.mjs.map +0 -1
  420. package/dist/_chunks/pt-GqKRRnNe.mjs +0 -25
  421. package/dist/_chunks/pt-GqKRRnNe.mjs.map +0 -1
  422. package/dist/_chunks/ru-dQr7xFOb.mjs +0 -43
  423. package/dist/_chunks/ru-dQr7xFOb.mjs.map +0 -1
  424. package/dist/_chunks/ru-wJyWus4I.js +0 -43
  425. package/dist/_chunks/ru-wJyWus4I.js.map +0 -1
  426. package/dist/_chunks/sk-mcEz1PMW.js +0 -28
  427. package/dist/_chunks/sk-mcEz1PMW.js.map +0 -1
  428. package/dist/_chunks/sk-nreoyD6V.mjs +0 -28
  429. package/dist/_chunks/sk-nreoyD6V.mjs.map +0 -1
  430. package/dist/_chunks/sv-V86KaP9y.js +0 -43
  431. package/dist/_chunks/sv-V86KaP9y.js.map +0 -1
  432. package/dist/_chunks/sv-kIUD_46v.mjs +0 -43
  433. package/dist/_chunks/sv-kIUD_46v.mjs.map +0 -1
  434. package/dist/_chunks/th-IcmZ0Yif.mjs +0 -28
  435. package/dist/_chunks/th-IcmZ0Yif.mjs.map +0 -1
  436. package/dist/_chunks/th-pZN4HdUY.js +0 -28
  437. package/dist/_chunks/th-pZN4HdUY.js.map +0 -1
  438. package/dist/_chunks/tr-CkXew0gQ.mjs +0 -43
  439. package/dist/_chunks/tr-CkXew0gQ.mjs.map +0 -1
  440. package/dist/_chunks/tr-fCijT6nA.js +0 -43
  441. package/dist/_chunks/tr-fCijT6nA.js.map +0 -1
  442. package/dist/_chunks/uk-E8Js7gDb.mjs +0 -27
  443. package/dist/_chunks/uk-E8Js7gDb.mjs.map +0 -1
  444. package/dist/_chunks/uk-TEHpQuls.js +0 -27
  445. package/dist/_chunks/uk-TEHpQuls.js.map +0 -1
  446. package/dist/_chunks/useDocumentation-0Rztpbjg.mjs +0 -66
  447. package/dist/_chunks/useDocumentation-0Rztpbjg.mjs.map +0 -1
  448. package/dist/_chunks/useDocumentation-ffVG-mHB.js +0 -65
  449. package/dist/_chunks/useDocumentation-ffVG-mHB.js.map +0 -1
  450. package/dist/_chunks/vi-Nxtm0xZz.js +0 -28
  451. package/dist/_chunks/vi-Nxtm0xZz.js.map +0 -1
  452. package/dist/_chunks/vi-k1R3Y3mS.mjs +0 -28
  453. package/dist/_chunks/vi-k1R3Y3mS.mjs.map +0 -1
  454. package/dist/_chunks/zh-Hans-FdUTcggu.mjs +0 -32
  455. package/dist/_chunks/zh-Hans-FdUTcggu.mjs.map +0 -1
  456. package/dist/_chunks/zh-Hans-tFSnVett.js +0 -32
  457. package/dist/_chunks/zh-Hans-tFSnVett.js.map +0 -1
  458. package/dist/_chunks/zh-Vd3mfBR-.mjs +0 -43
  459. package/dist/_chunks/zh-Vd3mfBR-.mjs.map +0 -1
  460. package/dist/_chunks/zh-bgauBZz8.js +0 -43
  461. package/dist/_chunks/zh-bgauBZz8.js.map +0 -1
  462. package/jest.config.front.js +0 -7
  463. package/jest.config.js +0 -6
  464. package/packup.config.ts +0 -22
  465. package/server/bootstrap.js +0 -54
  466. package/server/config/default-plugin-config.js +0 -35
  467. package/server/config/index.js +0 -7
  468. package/server/controllers/documentation.js +0 -241
  469. package/server/controllers/index.js +0 -7
  470. package/server/index.js +0 -17
  471. package/server/middlewares/documentation.js +0 -25
  472. package/server/middlewares/index.js +0 -7
  473. package/server/middlewares/restrict-access.js +0 -24
  474. package/server/public/index.html +0 -70
  475. package/server/public/login.html +0 -145
  476. package/server/register.js +0 -11
  477. package/server/routes/index.js +0 -84
  478. package/server/services/__mocks__/mock-content-types.js +0 -269
  479. package/server/services/__mocks__/mock-strapi-data.js +0 -183
  480. package/server/services/__tests__/build-component-schema.test.js +0 -761
  481. package/server/services/__tests__/documentation.test.js +0 -481
  482. package/server/services/__tests__/override.test.js +0 -85
  483. package/server/services/documentation.js +0 -247
  484. package/server/services/helpers/build-api-endpoint-path.js +0 -186
  485. package/server/services/helpers/build-component-schema.js +0 -254
  486. package/server/services/helpers/index.js +0 -9
  487. package/server/services/helpers/utils/clean-schema-attributes.js +0 -246
  488. package/server/services/helpers/utils/get-api-responses.js +0 -105
  489. package/server/services/helpers/utils/get-schema-data.js +0 -32
  490. package/server/services/helpers/utils/loop-content-type-names.js +0 -55
  491. package/server/services/helpers/utils/pascal-case.js +0 -9
  492. package/server/services/helpers/utils/query-params.js +0 -106
  493. package/server/services/helpers/utils/routes.js +0 -10
  494. package/server/services/index.js +0 -9
  495. package/server/services/override.js +0 -52
  496. package/server/services/utils/default-openapi-components.js +0 -40
  497. package/server/services/utils/get-plugins-that-need-documentation.js +0 -24
  498. package/strapi-server.js +0 -3
  499. package/tests/server.js +0 -37
  500. package/tests/setup.js +0 -15
@@ -0,0 +1,15 @@
1
+ import type { OpenAPIV3 } from 'openapi-types';
2
+ interface Options {
3
+ uniqueName: string;
4
+ route: {
5
+ method: string;
6
+ };
7
+ isListOfEntities?: boolean;
8
+ isLocalizationPath?: boolean;
9
+ }
10
+ /**
11
+ * @description - Builds the Swagger response object for a given api
12
+ */
13
+ declare const getApiResponse: ({ uniqueName, route, isListOfEntities, }: Options) => OpenAPIV3.ResponsesObject;
14
+ export default getApiResponse;
15
+ //# sourceMappingURL=get-api-responses.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-api-responses.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/get-api-responses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG/C,UAAU,OAAO;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,QAAA,MAAM,cAAc,GAAI,0CAIrB,OAAO,KAAG,SAAS,CAAC,eA8EtB,CAAC;AAEF,eAAe,cAAc,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { OpenAPIV3 } from 'openapi-types';
2
+ /**
3
+ * @description Determines the format of the data response
4
+ *
5
+ * @param {boolean} isListOfEntities - Checks for a multiple entities
6
+ * @param {object} attributes - The attributes found on a contentType
7
+
8
+ * @returns object | array of attributes
9
+ */
10
+ declare const _default: (isListOfEntities: boolean, attributes: Record<string, OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject>) => OpenAPIV3.SchemaObject;
11
+ export default _default;
12
+ //# sourceMappingURL=get-schema-data.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-schema-data.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/get-schema-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;;;;GAOG;yBAED,kBAAkB,OAAO,EACzB,YAAY,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,eAAe,CAAC,KAC7E,SAAS,CAAC,YAAY;AAHzB,wBA0BE"}
@@ -0,0 +1,7 @@
1
+ import type { Api, ApiInfo } from '../../../types';
2
+ /**
3
+ * @description A reusable loop for building api endpoint paths and component schemas
4
+ */
5
+ declare const loopContentTypeNames: (api: Api, callback: (info: ApiInfo) => any) => {};
6
+ export default loopContentTypeNames;
7
+ //# sourceMappingURL=loop-content-type-names.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"loop-content-type-names.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/loop-content-type-names.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,QAAA,MAAM,oBAAoB,GAAI,KAAK,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,KAAK,GAAG,OA2CvE,CAAC;AAEF,eAAe,oBAAoB,CAAC"}
@@ -0,0 +1,3 @@
1
+ declare const pascalCase: (string: string) => string;
2
+ export default pascalCase;
3
+ //# sourceMappingURL=pascal-case.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"pascal-case.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/pascal-case.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,UAAU,GAAI,QAAQ,MAAM,WAEjC,CAAC;AAEF,eAAe,UAAU,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { OpenAPIV3 } from 'openapi-types';
2
+ declare const params: OpenAPIV3.ParameterObject[];
3
+ export default params;
4
+ //# sourceMappingURL=query-params.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,QAAA,MAAM,MAAM,EAAE,SAAS,CAAC,eAAe,EAuGtC,CAAC;AAEF,eAAe,MAAM,CAAC"}
@@ -0,0 +1,3 @@
1
+ declare const hasFindMethod: (handler: unknown) => boolean;
2
+ export { hasFindMethod };
3
+ //# sourceMappingURL=routes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../../../../../../server/src/services/helpers/utils/routes.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,aAAa,GAAI,SAAS,OAAO,YAMtC,CAAC;AAEF,OAAO,EAAE,aAAa,EAAE,CAAC"}
@@ -0,0 +1,43 @@
1
+ import { type DocumentationService } from './documentation';
2
+ import { type OverrideService } from './override';
3
+ declare const _default: {
4
+ documentation: ({ strapi }: {
5
+ strapi: import("@strapi/types/dist/core").Strapi;
6
+ }) => {
7
+ getDocumentationVersion(): string;
8
+ getFullDocumentationPath(): string;
9
+ getDocumentationVersions(): import("./documentation").Version[];
10
+ getDocumentationAccess(): Promise<{
11
+ restrictedAccess: boolean;
12
+ }>;
13
+ getApiDocumentationPath(api: {
14
+ name: string;
15
+ getter: string;
16
+ }): string;
17
+ deleteDocumentation(version: string): Promise<void>;
18
+ getPluginAndApiInfo(): {
19
+ name: string;
20
+ getter: string;
21
+ ctNames: string[];
22
+ }[];
23
+ generateFullDoc(versionOpt?: string): Promise<void>;
24
+ };
25
+ override: ({ strapi }: {
26
+ strapi: import("@strapi/types/dist/core").Strapi;
27
+ }) => {
28
+ registeredOverrides: Partial<import("../types").PluginConfig>[];
29
+ excludedFromGeneration: string[];
30
+ excludeFromGeneration(api: string | string[]): void;
31
+ isEnabled(name: string): boolean;
32
+ registerOverride(override: Partial<import("../types").PluginConfig>, opts?: {
33
+ pluginOrigin: string;
34
+ excludeFromGeneration?: string[];
35
+ }): void;
36
+ };
37
+ };
38
+ export default _default;
39
+ export type Services = {
40
+ documentation: DocumentationService;
41
+ override: OverrideService;
42
+ };
43
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../server/src/services/index.ts"],"names":[],"mappings":"AAEA,OAAsB,EAAE,KAAK,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iCAW+nB,CAAC;;;;AAT5rB,wBAGE;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,aAAa,EAAE,oBAAoB,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC;CAC3B,CAAC"}
@@ -0,0 +1,21 @@
1
+ import type { Core } from '@strapi/types';
2
+ import type { PluginConfig } from '../types';
3
+ export type OverrideService = ReturnType<typeof createService>;
4
+ declare const createService: ({ strapi }: {
5
+ strapi: Core.Strapi;
6
+ }) => {
7
+ registeredOverrides: Partial<PluginConfig>[];
8
+ excludedFromGeneration: string[];
9
+ /**
10
+ *
11
+ * @param {(string | string[])} api - The name of the api or and array of apis to exclude from generation
12
+ */
13
+ excludeFromGeneration(api: string | string[]): void;
14
+ isEnabled(name: string): boolean;
15
+ registerOverride(override: Partial<PluginConfig>, opts?: {
16
+ pluginOrigin: string;
17
+ excludeFromGeneration?: string[];
18
+ }): void;
19
+ };
20
+ export default createService;
21
+ //# sourceMappingURL=override.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"override.d.ts","sourceRoot":"","sources":["../../../../server/src/services/override.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAG1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAE7C,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AAE/D,QAAA,MAAM,aAAa,GAAI,YAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAAE;;;IAOtD;;;OAGG;+BACwB,MAAM,GAAG,MAAM,EAAE;oBAU5B,MAAM;+BAKV,OAAO,CAAC,YAAY,CAAC,SACxB;QAAE,YAAY,EAAE,MAAM,CAAC;QAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE;CAwBtE,CAAC;AAEF,eAAe,aAAa,CAAC"}
@@ -0,0 +1,4 @@
1
+ import type { PluginConfig } from '../../types';
2
+ declare const getPluginsThatNeedDocumentation: (config: PluginConfig) => string[];
3
+ export { getPluginsThatNeedDocumentation };
4
+ //# sourceMappingURL=get-plugins-that-need-documentation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-plugins-that-need-documentation.d.ts","sourceRoot":"","sources":["../../../../../server/src/services/utils/get-plugins-that-need-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEhD,QAAA,MAAM,+BAA+B,GAAI,QAAQ,YAAY,aAmB5D,CAAC;AAEF,OAAO,EAAE,+BAA+B,EAAE,CAAC"}
@@ -0,0 +1,28 @@
1
+ import type { Core, Struct } from '@strapi/types';
2
+ import type { OpenAPIV3 } from 'openapi-types';
3
+ export interface Config {
4
+ restrictedAccess: boolean;
5
+ password?: string;
6
+ }
7
+ export type PluginConfig = OpenAPIV3.Document & {
8
+ info: OpenAPIV3.InfoObject & {
9
+ 'x-generation-date'?: string;
10
+ };
11
+ 'x-strapi-config': {
12
+ plugins: string[] | null;
13
+ mutateDocumentation?: ((state: OpenAPIV3.Document) => OpenAPIV3.Document) | null;
14
+ };
15
+ };
16
+ export interface ApiInfo {
17
+ routeInfo: Core.Router;
18
+ attributes: Struct.SchemaAttributes;
19
+ uniqueName: string;
20
+ contentTypeInfo: any;
21
+ kind: string;
22
+ }
23
+ export interface Api {
24
+ getter: string;
25
+ name: string;
26
+ ctNames: string[];
27
+ }
28
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../server/src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE/C,MAAM,WAAW,MAAM;IACrB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,GAAG;IAC9C,IAAI,EAAE,SAAS,CAAC,UAAU,GAAG;QAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,iBAAiB,EAAE;QACjB,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACzB,mBAAmB,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,QAAQ,KAAK,SAAS,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;KAClF,CAAC;CACH,CAAC;AAEF,MAAM,WAAW,OAAO;IACtB,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,GAAG,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB"}
@@ -0,0 +1,12 @@
1
+ import type { Core } from '@strapi/types';
2
+ import type { Services } from './services';
3
+ export declare const getService: <TName extends keyof Services>(name: TName, { strapi }?: {
4
+ strapi: Core.Strapi;
5
+ }) => Services[TName];
6
+ declare const _default: {
7
+ getService: <TName extends keyof Services>(name: TName, { strapi }?: {
8
+ strapi: Core.Strapi;
9
+ }) => Services[TName];
10
+ };
11
+ export default _default;
12
+ //# sourceMappingURL=utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../server/src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,MAAM,QAAQ,EACrD,MAAM,KAAK,EACX,aAAY;IAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;CAA8B,KAC9D,QAAQ,CAAC,KAAK,CAEhB,CAAC;;iBALyB,KAAK,SAAS,MAAM,QAAQ,QAC/C,KAAK,eACC;QAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAA;KAAE,KAClC,QAAQ,CAAC,KAAK,CAAC;;AAIlB,wBAEE"}
@@ -0,0 +1,10 @@
1
+ 'use strict';
2
+
3
+ const getService = (name, { strapi } = {
4
+ strapi: global.strapi
5
+ })=>{
6
+ return strapi.plugin('documentation').service(name);
7
+ };
8
+
9
+ exports.getService = getService;
10
+ //# sourceMappingURL=utils.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.js","sources":["../../server/src/utils.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport type { Services } from './services';\n\nexport const getService = <TName extends keyof Services>(\n name: TName,\n { strapi }: { strapi: Core.Strapi } = { strapi: global.strapi }\n): Services[TName] => {\n return strapi.plugin('documentation').service<Services[TName]>(name);\n};\n\nexport default {\n getService,\n};\n"],"names":["getService","name","strapi","global","plugin","service"],"mappings":";;MAIaA,UAAAA,GAAa,CACxBC,MACA,EAAEC,MAAM,EAA2B,GAAG;AAAEA,IAAAA,MAAAA,EAAQC,OAAOD;AAAO,CAAC,GAAA;AAE/D,IAAA,OAAOA,MAAAA,CAAOE,MAAM,CAAC,eAAA,CAAA,CAAiBC,OAAO,CAAkBJ,IAAAA,CAAAA;AACjE;;;;"}
@@ -0,0 +1,8 @@
1
+ const getService = (name, { strapi } = {
2
+ strapi: global.strapi
3
+ })=>{
4
+ return strapi.plugin('documentation').service(name);
5
+ };
6
+
7
+ export { getService };
8
+ //# sourceMappingURL=utils.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"utils.mjs","sources":["../../server/src/utils.ts"],"sourcesContent":["import type { Core } from '@strapi/types';\n\nimport type { Services } from './services';\n\nexport const getService = <TName extends keyof Services>(\n name: TName,\n { strapi }: { strapi: Core.Strapi } = { strapi: global.strapi }\n): Services[TName] => {\n return strapi.plugin('documentation').service<Services[TName]>(name);\n};\n\nexport default {\n getService,\n};\n"],"names":["getService","name","strapi","global","plugin","service"],"mappings":"MAIaA,UAAAA,GAAa,CACxBC,MACA,EAAEC,MAAM,EAA2B,GAAG;AAAEA,IAAAA,MAAAA,EAAQC,OAAOD;AAAO,CAAC,GAAA;AAE/D,IAAA,OAAOA,MAAAA,CAAOE,MAAM,CAAC,eAAA,CAAA,CAAiBC,OAAO,CAAkBJ,IAAAA,CAAAA;AACjE;;;;"}
@@ -0,0 +1,2 @@
1
+ declare const server: import("msw/node").SetupServer;
2
+ export { server };
package/package.json CHANGED
@@ -1,7 +1,11 @@
1
1
  {
2
2
  "name": "@strapi/plugin-documentation",
3
- "version": "0.0.0-experimental.62ebf57bb35846666febb5ee2078fe02fe990f57",
3
+ "version": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
4
4
  "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
5
+ "homepage": "https://strapi.io",
6
+ "bugs": {
7
+ "url": "https://github.com/strapi/strapi/issues"
8
+ },
5
9
  "repository": {
6
10
  "type": "git",
7
11
  "url": "https://github.com/strapi/strapi.git",
@@ -22,69 +26,89 @@
22
26
  ],
23
27
  "exports": {
24
28
  "./strapi-admin": {
25
- "source": "./admin/src/index.js",
29
+ "types": "./dist/admin/src/index.d.ts",
30
+ "source": "./admin/src/index.ts",
26
31
  "import": "./dist/admin/index.mjs",
27
32
  "require": "./dist/admin/index.js",
28
33
  "default": "./dist/admin/index.js"
29
34
  },
30
35
  "./strapi-server": {
31
- "source": "./strapi-server.js",
32
- "require": "./strapi-server.js",
33
- "default": "./strapi-server.js"
36
+ "types": "./dist/server/src/index.d.ts",
37
+ "source": "./server/src/index.ts",
38
+ "import": "./dist/server/index.mjs",
39
+ "require": "./dist/server/index.js",
40
+ "default": "./dist/server/index.js"
34
41
  },
35
42
  "./package.json": "./package.json"
36
43
  },
44
+ "files": [
45
+ "dist/",
46
+ "strapi-server.js"
47
+ ],
37
48
  "scripts": {
38
- "build": "pack-up build",
39
- "clean": "run -T rimraf dist",
49
+ "build": "run -T npm-run-all clean --parallel build:code build:types",
50
+ "build:code": "run -T rollup -c",
51
+ "build:types": "run -T run-p build:types:server build:types:admin",
52
+ "build:types:server": "run -T tsc -p server/tsconfig.build.json --emitDeclarationOnly",
53
+ "build:types:admin": "run -T tsc -p admin/tsconfig.build.json --emitDeclarationOnly",
54
+ "clean": "run -T rimraf ./dist",
40
55
  "lint": "run -T eslint .",
41
56
  "test:front": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js",
42
57
  "test:front:watch": "run -T cross-env IS_EE=true jest --config ./jest.config.front.js --watchAll",
43
- "test:unit": "jest --verbose",
58
+ "test:ts:front": "run -T tsc -p admin/tsconfig.json",
59
+ "test:ts:back": "run -T tsc --noEmit -p server/tsconfig.json",
60
+ "test:unit": "run -T jest --verbose",
44
61
  "test:unit:watch": "run -T jest --watch",
45
- "watch": "pack-up watch"
62
+ "watch": "run -T rollup -c -w"
46
63
  },
47
64
  "dependencies": {
48
- "@strapi/design-system": "1.19.0",
49
- "@strapi/helper-plugin": "0.0.0-experimental.62ebf57bb35846666febb5ee2078fe02fe990f57",
50
- "@strapi/icons": "1.19.0",
51
- "@strapi/utils": "0.0.0-experimental.62ebf57bb35846666febb5ee2078fe02fe990f57",
65
+ "@reduxjs/toolkit": "1.9.7",
66
+ "@strapi/admin": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
67
+ "@strapi/design-system": "2.2.1",
68
+ "@strapi/icons": "2.2.1",
69
+ "@strapi/utils": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
52
70
  "bcryptjs": "2.4.3",
53
- "cheerio": "^1.0.0-rc.12",
54
- "formik": "2.4.0",
55
- "fs-extra": "10.0.0",
56
- "immer": "9.0.19",
71
+ "cheerio": "^1.2.0",
72
+ "formik": "2.4.5",
73
+ "fs-extra": "11.3.4",
74
+ "immer": "9.0.21",
57
75
  "koa-static": "^5.0.0",
58
- "lodash": "4.17.21",
59
- "path-to-regexp": "6.3.0",
60
- "react-helmet": "^6.1.0",
61
- "react-intl": "6.4.1",
62
- "react-query": "3.39.3",
76
+ "lodash": "4.18.1",
77
+ "path-to-regexp": "8.4.2",
78
+ "react-intl": "6.6.2",
63
79
  "swagger-ui-dist": "4.19.0",
64
- "yaml": "1.10.2",
80
+ "yaml": "1.10.3",
65
81
  "yup": "0.32.9"
66
82
  },
67
83
  "devDependencies": {
68
84
  "@apidevtools/swagger-parser": "^10.1.0",
69
- "@strapi/pack-up": "4.23.0",
70
- "@strapi/strapi": "0.0.0-experimental.62ebf57bb35846666febb5ee2078fe02fe990f57",
71
- "@testing-library/react": "14.0.0",
72
- "@testing-library/user-event": "14.4.3",
73
- "msw": "1.3.0",
74
- "react": "^18.2.0",
75
- "react-dom": "^18.2.0",
76
- "react-router-dom": "5.3.4",
77
- "styled-components": "5.3.3"
85
+ "@strapi/admin-test-utils": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
86
+ "@strapi/strapi": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
87
+ "@strapi/types": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
88
+ "@testing-library/react": "16.3.2",
89
+ "@testing-library/user-event": "14.6.1",
90
+ "@types/fs-extra": "11.0.4",
91
+ "@types/koa": "2.15.2",
92
+ "@types/swagger-ui-dist": "3.30.4",
93
+ "koa": "2.16.4",
94
+ "koa-body": "6.0.1",
95
+ "koa-session": "7.0.2",
96
+ "msw": "2.13.4",
97
+ "openapi-types": "12.1.3",
98
+ "react": "18.3.1",
99
+ "react-dom": "18.3.1",
100
+ "react-router-dom": "6.30.3",
101
+ "styled-components": "6.4.1"
78
102
  },
79
103
  "peerDependencies": {
80
- "@strapi/strapi": "^4.0.0",
104
+ "@strapi/strapi": "0.0.0-experimental.6340da17068c3bed7fb006e7bcc554c71129e282",
81
105
  "react": "^17.0.0 || ^18.0.0",
82
106
  "react-dom": "^17.0.0 || ^18.0.0",
83
- "react-router-dom": "^5.2.0",
84
- "styled-components": "^5.2.1"
107
+ "react-router-dom": "^6.30.3",
108
+ "styled-components": "^6.0.0"
85
109
  },
86
110
  "engines": {
87
- "node": ">=18.0.0 <=20.x.x",
111
+ "node": ">=20.19.0 <=26.x.x",
88
112
  "npm": ">=6.0.0"
89
113
  },
90
114
  "strapi": {
@@ -92,6 +116,5 @@
92
116
  "name": "documentation",
93
117
  "description": "Create an OpenAPI Document and visualize your API with SWAGGER UI.",
94
118
  "kind": "plugin"
95
- },
96
- "gitHead": "62ebf57bb35846666febb5ee2078fe02fe990f57"
119
+ }
97
120
  }
package/.eslintignore DELETED
@@ -1 +0,0 @@
1
- dist
package/.eslintrc DELETED
@@ -1,17 +0,0 @@
1
- {
2
- "root": true,
3
- "overrides": [
4
- {
5
- "files": ["admin/**/*"],
6
- "extends": ["custom/front"],
7
- "rules": {
8
- "import/extensions": "off"
9
- }
10
- },
11
- {
12
- "files": ["**/*"],
13
- "excludedFiles": ["admin/**/*"],
14
- "extends": ["custom/back"]
15
- }
16
- ]
17
- }
@@ -1,17 +0,0 @@
1
- export const PERMISSIONS = {
2
- // This permission regards the main component (App) and is used to tell
3
- // If the plugin link should be displayed in the menu
4
- // And also if the plugin is accessible. This use case is found when a user types the url of the
5
- // plugin directly in the browser
6
- main: [
7
- { action: 'plugin::documentation.read', subject: null },
8
- { action: 'plugin::documentation.settings.regenerate', subject: null },
9
- { action: 'plugin::documentation.settings.update', subject: null },
10
- ],
11
- open: [
12
- { action: 'plugin::documentation.read', subject: null },
13
- { action: 'plugin::documentation.settings.regenerate', subject: null },
14
- ],
15
- regenerate: [{ action: 'plugin::documentation.settings.regenerate', subject: null }],
16
- update: [{ action: 'plugin::documentation.settings.update', subject: null }],
17
- };
@@ -1,77 +0,0 @@
1
- import { useEffect } from 'react';
2
-
3
- import { useFetchClient, useNotification, useAPIErrorHandler } from '@strapi/helper-plugin';
4
- import { useMutation, useQuery } from 'react-query';
5
-
6
- import pluginId from '../pluginId';
7
- import getTrad from '../utils/getTrad';
8
-
9
- export const useDocumentation = () => {
10
- const toggleNotification = useNotification();
11
- const { del, post, put, get } = useFetchClient();
12
-
13
- const { formatAPIError } = useAPIErrorHandler();
14
-
15
- const { isLoading, isError, data, refetch, error } = useQuery(
16
- ['get-documentation', pluginId],
17
- async () => {
18
- const { data } = await get(`/${pluginId}/getInfos`);
19
-
20
- return data;
21
- }
22
- );
23
-
24
- useEffect(() => {
25
- if (isError && error) {
26
- toggleNotification({
27
- type: 'warning',
28
- message: error ? formatAPIError(error) : { id: 'notification.error' },
29
- });
30
- }
31
- }, [isError, error, toggleNotification, formatAPIError]);
32
-
33
- const handleError = (err) => {
34
- toggleNotification({
35
- type: 'warning',
36
- message: formatAPIError(err),
37
- });
38
- };
39
-
40
- const handleSuccess = (type, tradId, defaultMessage) => {
41
- refetch();
42
- toggleNotification({
43
- type,
44
- message: { id: getTrad(tradId), defaultMessage },
45
- });
46
- };
47
-
48
- const deleteMutation = useMutation(
49
- ({ prefix, version }) => del(`${prefix}/deleteDoc/${version}`),
50
- {
51
- onSuccess: () =>
52
- handleSuccess('info', 'notification.delete.success', 'Successfully deleted documentation'),
53
- onError: handleError,
54
- }
55
- );
56
-
57
- const submit = useMutation(({ prefix, body }) => put(`${prefix}/updateSettings`, body), {
58
- onSuccess: () =>
59
- handleSuccess('success', 'notification.update.success', 'Successfully updated settings'),
60
- onError: handleError,
61
- });
62
-
63
- const regenerate = useMutation(
64
- ({ prefix, version }) => post(`${prefix}/regenerateDoc`, { version }),
65
- {
66
- onSuccess: () =>
67
- handleSuccess(
68
- 'info',
69
- 'notification.generate.success',
70
- 'Successfully generated documentation'
71
- ),
72
- onError: handleError,
73
- }
74
- );
75
-
76
- return { data, isLoading, isError, remove: deleteMutation, submit, regenerate };
77
- };
@@ -1,76 +0,0 @@
1
- // NOTE TO PLUGINS DEVELOPERS:
2
- // If you modify this file by adding new options to the plugin entry point
3
- // Here's the file: strapi/docs/3.0.0-beta.x/plugin-development/frontend-field-api.md
4
- // Here's the file: strapi/docs/3.0.0-beta.x/guides/registering-a-field-in-admin.md
5
- // Also the strapi-generate-plugins/files/admin/src/index.js needs to be updated
6
- // IF THE DOC IS NOT UPDATED THE PULL REQUEST WILL NOT BE MERGED
7
- import { prefixPluginTranslations } from '@strapi/helper-plugin';
8
- import { Information } from '@strapi/icons';
9
-
10
- import pluginPkg from '../../package.json';
11
-
12
- import { PERMISSIONS } from './constants';
13
- import pluginId from './pluginId';
14
-
15
- const name = pluginPkg.strapi.name;
16
-
17
- export default {
18
- register(app) {
19
- app.addMenuLink({
20
- to: `/plugins/${pluginId}`,
21
- icon: Information,
22
- intlLabel: {
23
- id: `${pluginId}.plugin.name`,
24
- defaultMessage: 'Documentation',
25
- },
26
- permissions: PERMISSIONS.main,
27
- async Component() {
28
- const component = await import('./pages/PluginPage');
29
-
30
- return component;
31
- },
32
- });
33
-
34
- app.registerPlugin({
35
- id: pluginId,
36
- name,
37
- });
38
- },
39
- bootstrap(app) {
40
- app.addSettingsLink('global', {
41
- intlLabel: {
42
- id: `${pluginId}.plugin.name`,
43
- defaultMessage: 'Documentation',
44
- },
45
- id: 'documentation',
46
- to: `/settings/${pluginId}`,
47
- async Component() {
48
- const component = await import('./pages/SettingsPage');
49
-
50
- return component;
51
- },
52
- permissions: PERMISSIONS.main,
53
- });
54
- },
55
- async registerTrads({ locales }) {
56
- const importedTrads = await Promise.all(
57
- locales.map((locale) => {
58
- return import(`./translations/${locale}.json`)
59
- .then(({ default: data }) => {
60
- return {
61
- data: prefixPluginTranslations(data, pluginId),
62
- locale,
63
- };
64
- })
65
- .catch(() => {
66
- return {
67
- data: {},
68
- locale,
69
- };
70
- });
71
- })
72
- );
73
-
74
- return Promise.resolve(importedTrads);
75
- },
76
- };