@keadex/docusaurus-plugin-mina 1.7.0 → 1.9.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 (5) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +22 -5
  3. package/package.json +5 -2
  4. package/src/index.js +27 -15
  5. package/src/index.js.map +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ # [1.8.0](https://github.com/keadex/keadex/compare/docusaurus-plugin-mina@1.7.0...docusaurus-plugin-mina@1.8.0) (2024-08-15)
2
+
3
+
4
+ ### Features
5
+
6
+ * **libs/docusaurus-plugin-mina:** trigger docusaurus plugin release ([cf8be98](https://github.com/keadex/keadex/commit/cf8be988b783eee43b8b1ddcc3860cee77508cfd))
7
+
8
+ # [1.7.0](https://github.com/keadex/keadex/compare/docusaurus-plugin-mina@1.6.0...docusaurus-plugin-mina@1.7.0) (2024-08-15)
9
+
10
+
11
+ ### Features
12
+
13
+ * **apps/keadex-battisti:** upgraded mina-react package ([69d7dba](https://github.com/keadex/keadex/commit/69d7dba3ca2ca08e76bba324739b444c85b0167e))
14
+
1
15
  # [1.6.0](https://github.com/keadex/keadex/compare/docusaurus-plugin-mina@1.5.0...docusaurus-plugin-mina@1.6.0) (2024-08-07)
2
16
 
3
17
 
package/README.md CHANGED
@@ -40,8 +40,20 @@ const config = {
40
40
  export default config
41
41
  ```
42
42
 
43
+ ### Import the Mina React CSS
44
+
45
+ `src\css\custom.css`
46
+
47
+ ```CSS
48
+ /* Other CSS rules */
49
+ @import "@keadex/mina-react/main.css";
50
+ ```
51
+
43
52
  ### Include the diagram into MDX files
44
53
 
54
+ > [!WARNING]
55
+ > The `MinaReact` component does not support SSR. Therefore, ensure that it is rendered only on the client side.
56
+
45
57
  `my-mina-diagram.mdx`
46
58
 
47
59
  ```md
@@ -51,12 +63,17 @@ sidebar_position: 1
51
63
 
52
64
  # My Mina Diagram
53
65
 
54
- import MinaReact from '@keadex/mina-react'
66
+ import BrowserOnly from '@docusaurus/BrowserOnly';
55
67
 
56
68
  <div style={{height: '50rem'}}>
57
- <MinaReact
58
- projectRootUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo"
59
- diagramUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo/diagrams/system-context/demo-diagram"
60
- />
69
+ <BrowserOnly fallback={<div>Loading...</div>}>
70
+ {() => {
71
+ const MinaReact = require('@keadex/mina-react').default;
72
+ return <MinaReact
73
+ projectRootUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo"
74
+ diagramUrl="https://raw.githubusercontent.com/keadex/keadex/main/examples/mina-react-example/demo_mina_project/Mina%20Demo/diagrams/system-context/demo-diagram"
75
+ />;
76
+ }}
77
+ </BrowserOnly>
61
78
  </div>
62
79
  ```
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "description": "Docusaurus plugin to render C4 Model diagrams created with Keadex Mina.",
4
4
  "author": "Keadex <keadex.it@gmail.com>",
5
5
  "license": "MIT",
6
- "version": "1.7.0",
6
+ "version": "1.9.0",
7
7
  "private": false,
8
8
  "type": "commonjs",
9
9
  "main": "./src/index.js",
@@ -27,8 +27,11 @@
27
27
  "mina"
28
28
  ],
29
29
  "dependencies": {
30
+ "bufferutil": "^4.0.8",
30
31
  "copy-webpack-plugin": "^9.1.0",
31
- "tslib": "^2.6.2"
32
+ "node-loader": "^2.0.0",
33
+ "tslib": "^2.6.2",
34
+ "utf-8-validate": "^6.0.4"
32
35
  },
33
36
  "devDependencies": {
34
37
  "@docusaurus/types": "3.1.1"
package/src/index.js CHANGED
@@ -8,32 +8,44 @@ function pluginMina({ siteConfig: { themeConfig }, }) {
8
8
  return {
9
9
  name: '@keadex/docusaurus-plugin-mina',
10
10
  configureWebpack(config, isServer) {
11
+ const newConfig = {};
11
12
  const minaReactPath = (0, path_1.dirname)(require.resolve('@keadex/mina-react', {
12
13
  paths: [process.cwd()],
13
14
  }));
14
15
  if (minaReactPath) {
15
- return {
16
- plugins: [
17
- new CopyPlugin({
18
- patterns: [
19
- {
20
- context: minaReactPath,
21
- from: '*.wasm',
22
- to() {
23
- return '[name][ext]';
24
- },
16
+ newConfig.plugins = [
17
+ new CopyPlugin({
18
+ patterns: [
19
+ {
20
+ context: minaReactPath,
21
+ from: '*.wasm',
22
+ to() {
23
+ return `${config.mode === 'production' ? 'assets/js/' : ''}[name][ext]`;
25
24
  },
26
- ],
27
- }),
28
- ],
29
- };
25
+ },
26
+ ],
27
+ }),
28
+ ];
30
29
  }
31
30
  else {
32
31
  throw new Error('Module @keadex/mina-react not found.');
33
32
  }
33
+ if (isServer) {
34
+ newConfig.module = {
35
+ rules: [
36
+ {
37
+ test: /\.node$/,
38
+ loader: 'node-loader',
39
+ },
40
+ ],
41
+ };
42
+ }
43
+ newConfig.experiments = {
44
+ asyncWebAssembly: true,
45
+ };
46
+ return newConfig;
34
47
  },
35
48
  };
36
49
  }
37
50
  exports.default = pluginMina;
38
- // trigger
39
51
  //# sourceMappingURL=index.js.map
package/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;;AAGtD,+BAAoC;AAEpC,8DAA8D;AAC9D,MAAM,UAAU,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAEjD,SAAS,UAAU,CAAC,EAClB,UAAU,EAAE,EAAE,WAAW,EAAE,GACf;IACZ,OAAO;QACL,IAAI,EAAE,gCAAgC;QACtC,gBAAgB,CAAC,MAAM,EAAE,QAAQ;YAC/B,MAAM,aAAa,GAAG,IAAA,cAAO,EAC3B,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE;gBACpC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;aACvB,CAAC,CACH,CAAA;YACD,IAAI,aAAa,EAAE;gBACjB,OAAO;oBACL,OAAO,EAAE;wBACP,IAAI,UAAU,CAAC;4BACb,QAAQ,EAAE;gCACR;oCACE,OAAO,EAAE,aAAa;oCACtB,IAAI,EAAE,QAAQ;oCACd,EAAE;wCACA,OAAO,aAAa,CAAA;oCACtB,CAAC;iCACF;6BACF;yBACF,CAAC;qBACH;iBACF,CAAA;aACF;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;aACxD;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAED,kBAAe,UAAU,CAAA;AAEzB,UAAU"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;;AAGtD,+BAA8B;AAE9B,8DAA8D;AAC9D,MAAM,UAAU,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAEjD,SAAS,UAAU,CAAC,EAClB,UAAU,EAAE,EAAE,WAAW,EAAE,GACf;IACZ,OAAO;QACL,IAAI,EAAE,gCAAgC;QACtC,gBAAgB,CAAC,MAAM,EAAE,QAAQ;YAC/B,MAAM,SAAS,GAAQ,EAAE,CAAA;YAEzB,MAAM,aAAa,GAAG,IAAA,cAAO,EAC3B,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE;gBACpC,KAAK,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;aACvB,CAAC,CACH,CAAA;YAED,IAAI,aAAa,EAAE;gBACjB,SAAS,CAAC,OAAO,GAAG;oBAClB,IAAI,UAAU,CAAC;wBACb,QAAQ,EAAE;4BACR;gCACE,OAAO,EAAE,aAAa;gCACtB,IAAI,EAAE,QAAQ;gCACd,EAAE;oCACA,OAAO,GACL,MAAM,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAChD,aAAa,CAAA;gCACf,CAAC;6BACF;yBACF;qBACF,CAAC;iBACH,CAAA;aACF;iBAAM;gBACL,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;aACxD;YAED,IAAI,QAAQ,EAAE;gBACZ,SAAS,CAAC,MAAM,GAAG;oBACjB,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,SAAS;4BACf,MAAM,EAAE,aAAa;yBACtB;qBACF;iBACF,CAAA;aACF;YAED,SAAS,CAAC,WAAW,GAAG;gBACtB,gBAAgB,EAAE,IAAI;aACvB,CAAA;YAED,OAAO,SAAS,CAAA;QAClB,CAAC;KACF,CAAA;AACH,CAAC;AAED,kBAAe,UAAU,CAAA"}