@bimdata/bcf-components 4.1.3 → 5.0.0

package/README.md

@@ -12,37 +12,10 @@ Install:
 npm install @bimdata/bcf-components
 ```
 
-Then refer to the next sub-sections on how to use the library depending
-on which version of Vue you're using.
-
-### Vue 2.7 application
-
-**Note:** the library won't work as expected for versions of Vue below **2.7**.
-
-In your Vue 2.7 application bootstrap script, add the following:
-
-```js
-import Vue from "vue";
-import VueI18n from "vue-i18n"; // v8.x
-import { makeBIMDataApiClient } from "@bimdata/typescript-fetch-api-client";  // v8.2+
-// Import Vue 2 plugin factory
-import BIMDataBcfComponents from "@bimdata/bcf-components/vue2-plugin.js";
-...
-
-// Instanciate i18n plugin
-const i18nPlugin = new VueI18n({ ... });
-// Instanciate BIMData API client
-const apiClient = makeBIMDataApiClient({ ... });
-
-Vue.use(i18nPlugin);
-// Provide both i18n plugin and API client as plugin config
-Vue.use(BIMDataBcfComponents({ i18nPlugin, apiClient }));
-...
-```
-
 ### Vue 3.x application
 
-**Using Vue plugin**
+> **Note:** The library is built for Vue 3.x applications, it is no longer intended
+> to work with older version of Vue.
 
 The package provide a Vue plugin that can be used to setup the library for your app
 and make all components available globally.
@@ -70,30 +43,6 @@ It is also possible to provide your own translations for i18n by removing
 `i18nPlugin` from plugin config and adding translation keys from
 [`src/i18n/lang/fr.js`](./src/i18n/lang/fr.json) to the translation files of your app.
 
-**Using "manual" setup**
-
-To setup the library without the use of the plugin you have to provide your own translations
-(as described above in the *Using Vue plugin* section) and inject an API client like so:
-
-```js
-import { makeBIMDataApiClient } from "@bimdata/typescript-fetch-api-client"; // v8.2+
-// Import `createService` and `setService` utils
-import { createService, setService } from "@bimdata/bcf-components";
-
-// Instanciate BIMData API client
-const apiClient = makeBIMDataApiClient({ ... });
-
-// Initialize library service
-const service = createService(apiClient);
-setService(service);
-```
-
-Then you can directly use components in your app that way:
-
-```js
-import { BcfTopicCard } from "@bimdata/bcf-components";
-```
-
 ## Build
 
 ```bash

package/package.json

@@ -1,28 +1,23 @@
 {
   "name": "@bimdata/bcf-components",
-  "version": "4.1.3",
+  "version": "5.0.0",
   "files": [
     "dist",
-    "vue2-plugin.js",
     "vue3-plugin.js"
   ],
-  "main": "./dist/vue3/bcf-components.mjs",
-  "module": "./dist/vue3/bcf-components.mjs",
+  "main": "./dist/bcf-components.mjs",
+  "module": "./dist/bcf-components.mjs",
   "scripts": {
-    "prebuild:vue2": "node pre-build-vue2.js",
-    "build:vue2": "vite build --config vue2-build.config.js",
-    "build:vue3": "vite build --config vue3-build.config.js",
-    "build": "npm run build:vue2 && npm run build:vue3",
+    "build": "vite build --config build.config.js",
     "prepublishOnly": "npm run build",
     "release": "semantic-release"
   },
   "peerDependencies": {
-    "vue": "^2.7 || ^3.0"
+    "vue": "^3.0"
   },
   "devDependencies": {
     "@bimdata/design-system": "2.0.0-rc.11",
     "@bimdata/vite-plugin-libcss": "0.0.1",
-    "@rollup/plugin-replace": "^5.0.2",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^9.0.2",
     "@semantic-release/git": "^10.0.1",
@@ -32,12 +27,9 @@
     "@vitejs/plugin-vue": "^4.2.1",
     "async": "^3.2.4",
     "conventional-changelog-eslint": "^3.0.9",
-    "rollup-plugin-copy": "^3.4.0",
     "sass": "^1.62.1",
     "semantic-release": "^21.0.2",
     "vite": "^4.3.5",
-    "vite-plugin-vue2": "^2.0.3",
-    "vue-template-compiler": "^2.7.14",
-    "vue2": "npm:vue@^2.7.14"
+    "vite-plugin-static-copy": "^0.16.0"
   }
 }

package/vue3-plugin.js

@@ -1,8 +1,8 @@
 import {
+  components,
   createService,
   setService,
-  components
-} from "./dist/vue3/bcf-components.mjs";
+} from "./dist/bcf-components.mjs";
 import messages from "./dist/i18n/index.js";
 
 /**
@@ -16,9 +16,7 @@ import messages from "./dist/i18n/index.js";
  *  {
  *    apiClient: Object,
  *    fetchUsers?: Promise,
- *    i18nPlugin: Object,
- *    includedComponents?: string[],
- *    excludedComponents?: string[],
+ *    i18nPlugin?: Object,
  *  } 
  * }
  */
@@ -26,8 +24,6 @@ const pluginFactory = ({
   apiClient,
   fetchUsers,
   i18nPlugin,
-  includedComponents = [],
-  excludedComponents = [],
 } = {}) => {
   return {
     install(app) {
@@ -54,21 +50,9 @@ const pluginFactory = ({
         );
       }
 
-      Object.entries(components)
-        .forEach(([name, component]) => {
-          // Do not register excluded components.
-          if (excludedComponents.includes(name)) {
-            return;
-          }
-          // Only register included components if any.
-          // Otherwise register all (non excluded) components.
-          if (
-            includedComponents.length === 0 ||
-            includedComponents.includes(name)
-          ) {
-            app.component(name, component);
-          }
-        });
+      Object.entries(components).forEach(([name, component]) => {
+        app.component(name, component);
+      });
     },
   };
 };