Bump documentation from 13.2.5 to 14.0.3

docs/api.js → docs/api.mjs

@@ -1,23 +1,28 @@
 // This script uses documentation to generate API Reference files
-const path = require('path');
-const documentation = require('documentation');
-const fs = require('fs');
+import { join, basename, dirname } from 'path';
+import { build, formats } from 'documentation';
+import { fileURLToPath } from 'url';
+import { existsSync, writeFileSync } from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
 const docRoot = __dirname;
-const srcRoot = path.join(docRoot, '../src/');
-const START_EVENTS = '{START_EVENTS}';
-const END_EVENTS = '{END_EVENTS}';
-const REPLACE_EVENTS = '{REPLACE_EVENTS}';
+const srcRoot = join(docRoot, '../src/');
+const START_EVENTS = '{START\\_EVENTS}';
+const END_EVENTS = '{END\\_EVENTS}';
+const REPLACE_EVENTS = '{REPLACE\\_EVENTS}';
 
 const log = (...args) => console.log(...args);
 
 const getEventsMdFromTypes = async (filePath) => {
-  const dirname = filePath.replace(path.basename(filePath), '');
+  const dirname = filePath.replace(basename(filePath), '');
   const typesFilePath = `${dirname}types.ts`;
 
-  if (fs.existsSync(typesFilePath)) {
-    const resTypes = await documentation
-      .build([typesFilePath], { shallow: true })
-      .then((cm) => documentation.formats.md(cm /*{ markdownToc: true }*/));
+  if (existsSync(typesFilePath)) {
+    const resTypes = await build([typesFilePath], { shallow: true }).then((cm) =>
+      formats.md(cm /*{ markdownToc: true }*/),
+    );
     const indexFrom = resTypes.indexOf(START_EVENTS) + START_EVENTS.length;
     const indexTo = resTypes.indexOf(END_EVENTS);
     // console.log(`${resTypes}`)
@@ -85,13 +90,12 @@ async function generateDocs() {
     ].map(async (file) => {
       const filePath = `${srcRoot}/${file[0]}`;
 
-      if (!fs.existsSync(filePath)) {
+      if (!existsSync(filePath)) {
         throw `File not found '${filePath}'`;
       }
 
-      return documentation
-        .build([filePath], { shallow: true })
-        .then((cm) => documentation.formats.md(cm /*{ markdownToc: true }*/))
+      return build([filePath], { shallow: true })
+        .then((cm) => formats.md(cm /*{ markdownToc: true }*/))
         .then(async (output) => {
           let addLogs = [];
           let result = output
@@ -114,7 +118,7 @@ async function generateDocs() {
             result = eventsMd ? result.replace(REPLACE_EVENTS, `## Available Events\n${eventsMd}`) : result;
           }
 
-          fs.writeFileSync(`${docRoot}/api/${file[1]}`, result);
+          writeFileSync(`${docRoot}/api/${file[1]}`, result);
           log('Created', file[1], addLogs.length ? `(${addLogs.join(', ')})` : '');
         });
     }),

docs/api/asset.md

@@ -18,7 +18,7 @@ Get asset type.
 asset.getType(); // -> 'image'
 ```
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getSrc
 
@@ -31,7 +31,7 @@ Get asset URL.
 asset.getSrc(); // -> 'https://.../image.png'
 ```
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getFilename
 
@@ -46,7 +46,7 @@ asset.getFilename(); // -> 'image.png'
 asset.getFilename(); // -> 'image'
 ```
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getExtension
 
@@ -61,6 +61,6 @@ asset.getExtension(); // -> 'png'
 asset.getExtension(); // -> ''
 ```
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

docs/api/assets.md

@@ -73,7 +73,7 @@ editor.on('asset:upload:error', (error) => { ... });
 editor.on('asset:upload:response', (res) => { ... });
 ```
 
-* `asset:custom` Event to use in case of [custom Asset Manager UI](https://grapesjs.com/docs/modules/Assets.html#customization).
+* `asset:custom` Event to use in case of [custom Asset Manager UI](https\://grapesjs.com/docs/modules/Assets.html#customization).
 
 ```javascript
 editor.on('asset:custom', ({ container, assets, ... }) => { ... });
@@ -148,7 +148,7 @@ Checks if the asset manager is open
 assetManager.isOpen(); // true | false
 ```
 
-Returns **[Boolean][15]** 
+Returns **[Boolean][15]** 
 
 ## add
 
@@ -176,7 +176,7 @@ width: 200,
 assetManager.add([{ src: 'img2.jpg' }, { src: 'img2.png' }]);
 ```
 
-Returns **[Asset]** 
+Returns **[Asset]** 
 
 ## get
 
@@ -192,19 +192,19 @@ Return asset by URL
 const asset = assetManager.get('http://img.jpg');
 ```
 
-Returns **([Asset] | null)** 
+Returns **([Asset] | null)** 
 
 ## getAll
 
 Return the global collection, containing all the assets
 
-Returns **Collection<[Asset]>** 
+Returns **Collection<[Asset]>**&#x20;
 
 ## getAllVisible
 
 Return the visible collection, which contains assets actually rendered
 
-Returns **Collection<[Asset]>** 
+Returns **Collection<[Asset]>**&#x20;
 
 ## remove
 
@@ -213,7 +213,7 @@ Remove asset
 ### Parameters
 
 *   `asset` **([String][13] | [Asset])** Asset or asset URL
-*   `opts` **RemoveOptions?** 
+*   `opts` **RemoveOptions?**&#x20;
 
 ### Examples
 
@@ -230,7 +230,7 @@ Returns **[Asset]** Removed asset
 
 Return the Asset Manager Container
 
-Returns **[HTMLElement][16]** 
+Returns **[HTMLElement][16]**&#x20;
 
 [1]: https://github.com/GrapesJS/grapesjs/blob/master/src/asset_manager/config/config.ts
 

docs/api/block.md

@@ -19,31 +19,31 @@
 
 Get block id
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getLabel
 
 Get block label
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getMedia
 
 Get block media
 
-Returns **[String][1]** 
+Returns **[String][1]** 
 
 ## getContent
 
 Get block content
 
-Returns **([Object][2] | [String][1] | [Array][6]<([Object][2] | [String][1])>)** 
+Returns **([Object][2] | [String][1] | [Array][6]<([Object][2] | [String][1])>)**&#x20;
 
 ## getCategoryLabel
 
 Get block category label
 
-Returns **[String][1]** 
+Returns **[String][1]**&#x20;
 
 [1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
 

docs/api/block_manager.md

@@ -72,7 +72,7 @@ editor.on('block:drag:stop', (component, block) => { ... });
 editor.on('block:category:update', ({ category, changes }) => { ... });
 ```
 
-* `block:custom` Event to use in case of [custom Block Manager UI](https://grapesjs.com/docs/modules/Blocks.html#customization).
+* `block:custom` Event to use in case of [custom Block Manager UI](https\://grapesjs.com/docs/modules/Blocks.html#customization).
 
 ```javascript
 editor.on('block:custom', ({ container, blocks, ... }) => { ... });
@@ -92,7 +92,7 @@ editor.on('block', ({ event, model, ... }) => { ... });
 
 Get configuration object
 
-Returns **[Object][2]** 
+Returns **[Object][2]** 
 
 ## add
 
@@ -135,7 +135,7 @@ console.log(JSON.stringify(block));
 // {label: 'Heading', content: '<h1>Put your ...', ...}
 ```
 
-Returns **[Block]** 
+Returns **[Block]**&#x20;
 
 ## getAll
 
@@ -149,13 +149,13 @@ console.log(JSON.stringify(blocks));
 // [{label: 'Heading', content: '<h1>Put your ...'}, ...]
 ```
 
-Returns **Collection<[Block]>** 
+Returns **Collection<[Block]>**&#x20;
 
 ## getAllVisible
 
 Return the visible collection, which containes blocks actually rendered
 
-Returns **Collection<[Block]>** 
+Returns **Collection<[Block]>**&#x20;
 
 ## remove
 
@@ -182,28 +182,28 @@ Returns **[Block]** Removed block
 Get all available categories.
 It's possible to add categories only within blocks via 'add()' method
 
-Returns **([Array][4] | Collection)** 
+Returns **([Array][4] | Collection)**&#x20;
 
 ## getContainer
 
 Return the Blocks container element
 
-Returns **[HTMLElement][5]** 
+Returns **[HTMLElement][5]**&#x20;
 
 ## getDragBlock
 
 Returns currently dragging block.
 Updated when the drag starts and cleared once it's done.
 
-Returns **([Block] | [undefined][6])** 
+Returns **([Block] | [undefined][6])**&#x20;
 
 ## getBlocksByCategory
 
 Get blocks by category.
 
 ### Parameters
 
-*   `blocks` **[Array][4]\<Block>?** 
+*   `blocks` **[Array][4]\<Block>?**&#x20;
 
 ### Examples
 
@@ -219,7 +219,7 @@ const myFilteredBlocks: Block[] = [...];
 blockManager.getBlocksByCategorymyFilteredBlocks
 ```
 
-Returns **[Array][4]\<BlocksByCategory>** 
+Returns **[Array][4]\<BlocksByCategory>**&#x20;
 
 ## render