@inriver/inri 1.38.0 → 1.39.0

package/.changeset/tender-lobsters-study.md

@@ -0,0 +1,5 @@
+---
+"@inriver/inri": minor
+---
+
+Add option to opt-out of the global error handler when using initInriFramework

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @inriver/inri
 
+## 1.39.0
+
+### Minor Changes
+
+- Add notBlank validator
+- Added support for supplying a string function to determine option label name in CSelect
+- Update documentation
+- Add correct class to the c-btn component
+- Wallop font is now included in the package
+- Add back button slot
+- Updating README and exporting tailwing config
+- Add option to opt-out of the global error handler when using initInriFramework
+- Add support for placing CDialog action buttons to the right
+
+### Patch Changes
+
+- Provide global app configs
+- Fix CSelect placeholder color. Modularize Sass imports. Include inri typings when bundling
+- Fix Sass warnings and errors by removing usage of @apply and updating Quasar + sass dependencies
+- Add support for showing tooltips when hovering over CSelect and options. Add disable support and styling. Fix required validation to work with empty arrays.
+- Fix broken imports due to faulty declaration file
+- Add support for hiding the sidebars in CLayoutWithSidebars. Add support for entering a custom title in CLayoutWithSidebars
+- Add support for showing placeholder ()in CSelect eoutside of use-input mode
+- Fix faulty import path in globalAppConfig
+- Add error slot in CSelect
+- Fix error when CSelect is passed object options with falsy values
+
 ## 1.38.0
 
 ### Minor Changes

package/README.md

@@ -62,8 +62,10 @@ import App from './App.vue';
 import 'virtual:windi.css';
 
 import { initInriFramework } from '@inriver/inri';
+const Inri = initInriFramework();
+
 const app = createApp(App);
-app.use(initInriFramework);
+app.use(Inri);
 
 app.mount('#app');
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inriver/inri",
-  "version": "1.38.0",
+  "version": "1.39.0",
   "main": "index.ts",
   "peerDependencies": {
     "quasar": "2.14.2",

package/src/init/initInriFramework.ts

@@ -6,30 +6,64 @@ import { registerAppConfigurations } from '../plugins/globalAppConfig'
 import { i18n } from '../plugins/i18n'
 import logger from '../plugins/errors/logger'
 import { VueErrorHandler } from '../plugins/errors/vueErrorHandler'
-import '../plugins/errors/globalErrorHandler'
+import { useGlobalErrorHandler } from '../plugins/errors/globalErrorHandler'
 
 // Quasar plugins
 import iconSet from 'quasar/icon-set/mdi-v6'
 import '@quasar/extras/mdi-v6/mdi-v6.css'
 iconSet.field.error = 'mdi-alert-circle-outline'
 
-export const initInriFramework = (Vue: App): void => {
-  // Register C-components
-  registerComponents(Vue)
-
-  // Register global application configurations
-  registerAppConfigurations(Vue)
-
-  Vue.use(Quasar as any, {
-    plugins: {
-      Notify,
-      Dialog,
-      Meta,
-    },
-    iconSet: iconSet,
-  })
-  Vue.use(i18n)
-  Vue.use(VueErrorHandler)
-
-  logger.init()
+interface InriInitializationOptions {
+  useInriComponents?: boolean,
+  useInriAppConfigurations?: boolean,
+  useInriErrorHandler?: boolean,
+}
+
+const defaultInitializationOptions: InriInitializationOptions = {
+  useInriComponents: true,
+  useInriAppConfigurations: true,
+  useInriErrorHandler: true,
+}
+
+/**
+ * Returns an install function that can be used on Vue applications to install Inri
+ *
+ * Usage:
+ *
+ * const Inri = initInriFramework();
+ *
+ * app.use(Inri);
+ *
+ * @param options
+ * @returns
+ */
+export function initInriFramework (options: InriInitializationOptions = defaultInitializationOptions) {
+  return (Vue: App) => {
+    if (options.useInriComponents) {
+      // Register C-components
+      registerComponents(Vue)
+    }
+
+    if (options.useInriAppConfigurations) {
+      // Register global application configurations
+      registerAppConfigurations(Vue)
+    }
+
+    if (options.useInriErrorHandler) {
+      useGlobalErrorHandler()
+    }
+
+    Vue.use(Quasar as any, {
+      plugins: {
+        Notify,
+        Dialog,
+        Meta,
+      },
+      iconSet: iconSet,
+    })
+    Vue.use(i18n)
+    Vue.use(VueErrorHandler)
+
+    logger.init()
+  }
 }

package/src/plugins/errors/globalErrorHandler.ts

@@ -1,21 +1,23 @@
 import handleError from './handleError'
 
-// Handle errors outside of components
-window.addEventListener('error', (event) => {
-  handleError(
-    {
-      err: event,
-      caughtBy: 'window eventListener on error',
-    },
-  )
-})
+export function useGlobalErrorHandler () {
+  // Handle errors outside of components
+  window.addEventListener('error', (event) => {
+    handleError(
+      {
+        err: event,
+        caughtBy: 'window eventListener on error',
+      },
+    )
+  })
 
-// Handle rejected promises outside components
-window.addEventListener('unhandledrejection', (event) => {
-  handleError(
-    {
-      err: event,
-      caughtBy: 'window eventListener on unhandledrejection',
-    },
-  )
-})
+  // Handle rejected promises outside components
+  window.addEventListener('unhandledrejection', (event) => {
+    handleError(
+      {
+        err: event,
+        caughtBy: 'window eventListener on unhandledrejection',
+      },
+    )
+  })
+}