@kong-ui-public/expressions 0.3.13 → 0.3.14-pr.1497.dd00ad8f.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 (34) hide show
  1. package/README.md +6 -2
  2. package/dist/expressions.es.js +2 -2
  3. package/dist/style.css +1 -1
  4. package/dist/types/components/ExpressionsEditor.vue.d.ts +9 -0
  5. package/dist/types/components/ExpressionsEditor.vue.d.ts.map +1 -1
  6. package/dist/types/components/MonacoEditor.vue.d.ts +69 -0
  7. package/dist/types/components/MonacoEditor.vue.d.ts.map +1 -0
  8. package/dist/types/components/PageHeader.vue.d.ts +33 -0
  9. package/dist/types/components/PageHeader.vue.d.ts.map +1 -0
  10. package/dist/types/components/RequestCard.vue.d.ts +38 -0
  11. package/dist/types/components/RequestCard.vue.d.ts.map +1 -0
  12. package/dist/types/components/RequestImportModal.vue.d.ts +23 -0
  13. package/dist/types/components/RequestImportModal.vue.d.ts.map +1 -0
  14. package/dist/types/components/RequestModal.vue.d.ts +24 -0
  15. package/dist/types/components/RequestModal.vue.d.ts.map +1 -0
  16. package/dist/types/components/RouterPlayground.vue.d.ts +42 -0
  17. package/dist/types/components/RouterPlayground.vue.d.ts.map +1 -0
  18. package/dist/types/components/RouterPlaygroundModal.vue.d.ts +33 -0
  19. package/dist/types/components/RouterPlaygroundModal.vue.d.ts.map +1 -0
  20. package/dist/types/components/SupportText.vue.d.ts +10 -0
  21. package/dist/types/components/SupportText.vue.d.ts.map +1 -0
  22. package/dist/types/composables/index.d.ts +6 -0
  23. package/dist/types/composables/index.d.ts.map +1 -0
  24. package/dist/types/composables/useI18n.d.ts +222 -0
  25. package/dist/types/composables/useI18n.d.ts.map +1 -0
  26. package/dist/types/definitions.d.ts +24 -0
  27. package/dist/types/definitions.d.ts.map +1 -0
  28. package/dist/types/index.d.ts +2 -1
  29. package/dist/types/index.d.ts.map +1 -1
  30. package/dist/types/schema.d.ts +2 -0
  31. package/dist/types/schema.d.ts.map +1 -1
  32. package/dist/types/utils.d.ts +9 -0
  33. package/dist/types/utils.d.ts.map +1 -0
  34. package/package.json +11 -6
package/README.md CHANGED
@@ -18,6 +18,7 @@ Reusable components to support [Kong's expressions language](https://docs.konghq
18
18
  - `vue` must be initialized in the host application
19
19
  - [`monaco-editor`](https://www.npmjs.com/package/monaco-editor) is required as a dependency in the host application
20
20
  - [`vite-plugin-monaco-editor`](https://www.npmjs.com/package/vite-plugin-monaco-editor) is a required Vite plugin to bundle the Monaco Editor and its web workers
21
+ - [`@kong-ui-public/forms`](https://www.npmjs.com/package/@kong-ui-public/forms) is an optional dependency required for the `RouterPlaygroundModal` component
21
22
 
22
23
  ## Usage
23
24
 
@@ -27,6 +28,7 @@ Install required `dependencies` in your host application:
27
28
 
28
29
  ```sh
29
30
  yarn add monaco-editor
31
+ yarn add @kong-ui-public/forms # optional: required for `RouterPlaygroundModal` component
30
32
  ```
31
33
 
32
34
  Install required `devDependencies` in your host application:
@@ -58,9 +60,10 @@ Import the component(s) in your host application as well as the package styles:
58
60
  ```ts
59
61
  import { asyncInit, ExpressionsEditor } from '@kong-ui-public/expressions'
60
62
  import '@kong-ui-public/expressions/dist/style.css'
63
+ import '@kong-ui-public/forms/dist/style.css' // optional: required for `RouterPlaygroundModal` component
61
64
  ```
62
65
 
63
- This package utilizes [vite-plugin-top-level-await](https://github.com/Menci/vite-plugin-top-level-await) to transform code in order to use top-level await on older browsers. To load the WASM correctly, you must use `await` or `Promise.then` to wait the imported `asyncInit` before using any other imported values.
66
+ This package utilizes [vite-plugin-top-level-await](https://github.com/Menci/vite-plugin-top-level-await) to transform code in order to use top-level await on older browsers. To load the WASM correctly, you must use `await` or `Promise.then` to wait the imported `asyncInit` before using any other imported values.
64
67
 
65
68
  For example:
66
69
 
@@ -77,4 +80,5 @@ You can also make use of Vue's experimental [Suspense](https://vuejs.org/guide/b
77
80
 
78
81
  ## Individual component documentation
79
82
 
80
- - [`<ExpressionsEditor.vue />`](docs/expressions-editor.md)
83
+ - [`<ExpressionsEditor />`](docs/expressions-editor.md)
84
+ - [`<RouterPlaygroundModal />`](docs/router-playground-modal.md)