@edifice.io/tiptap-extensions 1.5.16-develop-rc.2 → 2.0.0-develop-rc.0

package/README.md

@@ -0,0 +1,63 @@
+# Edifice Rich Text Editor Extensions
+
+![npm](https://img.shields.io/npm/v/@edifice.io/tiptap-extensions?style=flat-square)
+![bundlephobia](https://img.shields.io/bundlephobia/min/@edifice.io/tiptap-extensions?style=flat-square)
+
+Extensions based on Tiptap Editor
+
+## Getting Started
+
+### Install
+
+```bash
+pnpm add @edifice.io/tiptap-extensions
+```
+
+### Imports
+
+#### Global
+
+```bash
+import { Alert, Video } from "@edifice.io/tiptap-extensions"
+```
+
+#### Sub-imports
+
+```bash
+import { Alert } from "@edifice.io/tiptap-extensions/alert"
+```
+
+## New extension
+
+To create a new extension, please do as follow :
+
+- Create a subfolder in `src` with the name of the extension (e.g: `my-extension`)
+
+```
+my-extension
+```
+
+- Create two files inside the new folder:
+  - `index.ts`
+  - `my-extension.ts`
+
+```
+my-extension
+└── my-extension.ts
+└── index.ts
+```
+
+- Check one existing extension or refer to this documentation to develop the extension -> [Tiptap](https://tiptap.dev/docs/editor/extensions/custom-extensionsv)
+
+- Then, add your extension in the `package.json` sub-exports in alphabetical order
+
+```
+"./my-extension": {
+  "import": "./dist/my-extension/my-extension.js",
+  "require": "./dist/my-extension/my-extension.cjs"
+}
+```
+
+- Run `pnpm run build` to generate a bundle
+
+- Test your extension before committing and pushing to remote

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@edifice.io/tiptap-extensions",
-  "version": "1.5.16-develop-rc.2",
+  "version": "2.0.0-develop-rc.0",
   "description": "Edifice Rich Text Editor Extensions",
   "homepage": "https://github.com/edificeio/edifice-ui/tree/main/packages/tiptap/extensions#readme",
   "bugs": {
@@ -99,6 +99,9 @@
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "vite build",
     "fix": "eslint . --ext ts --report-unused-disable-directives --max-warnings 0",
@@ -129,5 +132,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "31c5ddef7d29e860f5f034b13cdd62ff2899f730"
+  "gitHead": "6f136eacef86c18be3da824cbf7b9b6bea784457"
 }

package/.turbo/turbo-build.log

@@ -1,58 +0,0 @@
- WARN  Issue while reading "/home/runner/work/edifice-ui/edifice-ui/.npmrc". Failed to replace env in config: ${NPM_TOKEN}
-
-> @edifice.io/tiptap-extensions@0.0.1 build /home/runner/work/edifice-ui/edifice-ui/packages/tiptap/extensions
-> vite build
-
-vite v5.4.2 building for production...
-"build.lib.formats" will be ignored because "build.rollupOptions.output" is already an array format.
-transforming...
-✓ 40 modules transformed.
-rendering chunks...
-
-[vite:dts] Start generate declaration files...
-computing gzip size...
-dist/transform/html-to-json/html-to-json.js    0.20 kB │ gzip: 0.16 kB │ map: 0.38 kB
-dist/transform/json-to-html/json-to-html.js    0.20 kB │ gzip: 0.16 kB │ map: 0.38 kB
-dist/paragraph/paragraph.js                    0.35 kB │ gzip: 0.25 kB │ map: 1.14 kB
-dist/highlight/highlight.js                    0.59 kB │ gzip: 0.32 kB │ map: 0.95 kB
-dist/abbr/abbr.js                              0.63 kB │ gzip: 0.31 kB │ map: 1.61 kB
-dist/table-cell/table-cell.js                  0.70 kB │ gzip: 0.37 kB │ map: 1.38 kB
-dist/alert/alert.js                            0.77 kB │ gzip: 0.36 kB │ map: 1.52 kB
-dist/line-height/line-height.js                0.79 kB │ gzip: 0.39 kB │ map: 1.38 kB
-dist/speech-synthesis/speech-synthesis.js      0.81 kB │ gzip: 0.36 kB │ map: 1.98 kB
-dist/font-size/font-size.js                    1.04 kB │ gzip: 0.47 kB │ map: 2.34 kB
-dist/mathjax/mathjax.js                        1.12 kB │ gzip: 0.52 kB │ map: 2.33 kB
-dist/audio/audio.js                            1.23 kB │ gzip: 0.52 kB │ map: 2.84 kB
-dist/hyperlink/hyperlink.js                    1.49 kB │ gzip: 0.64 kB │ map: 3.34 kB
-dist/index.js                                  1.49 kB │ gzip: 0.51 kB │ map: 0.11 kB
-dist/heading/heading.js                        1.55 kB │ gzip: 0.66 kB │ map: 3.71 kB
-dist/iframe/iframe.js                          1.70 kB │ gzip: 0.59 kB │ map: 3.81 kB
-dist/attachment/attachment.js                  2.00 kB │ gzip: 0.76 kB │ map: 4.23 kB
-dist/linker/linker.js                          2.22 kB │ gzip: 0.83 kB │ map: 5.62 kB
-dist/speech-recognition/speech-recognition.js  2.29 kB │ gzip: 0.82 kB │ map: 5.24 kB
-dist/video/video.js                            3.04 kB │ gzip: 0.95 kB │ map: 6.73 kB
-dist/image/custom-image.js                     4.13 kB │ gzip: 1.28 kB │ map: 8.50 kB
-[vite:dts] Declaration files built in 3362ms.
-
-dist/transform/html-to-json/html-to-json.cjs    0.18 kB │ gzip: 0.16 kB │ map: 0.40 kB
-dist/transform/json-to-html/json-to-html.cjs    0.18 kB │ gzip: 0.16 kB │ map: 0.40 kB
-dist/paragraph/paragraph.cjs                    0.37 kB │ gzip: 0.27 kB │ map: 1.10 kB
-dist/highlight/highlight.cjs                    0.52 kB │ gzip: 0.33 kB │ map: 0.86 kB
-dist/abbr/abbr.cjs                              0.53 kB │ gzip: 0.32 kB │ map: 1.53 kB
-dist/alert/alert.cjs                            0.59 kB │ gzip: 0.37 kB │ map: 1.34 kB
-dist/line-height/line-height.cjs                0.62 kB │ gzip: 0.39 kB │ map: 1.27 kB
-dist/table-cell/table-cell.cjs                  0.62 kB │ gzip: 0.37 kB │ map: 1.30 kB
-dist/speech-synthesis/speech-synthesis.cjs      0.79 kB │ gzip: 0.38 kB │ map: 1.93 kB
-dist/font-size/font-size.cjs                    0.80 kB │ gzip: 0.46 kB │ map: 2.22 kB
-dist/hyperlink/hyperlink.cjs                    0.92 kB │ gzip: 0.48 kB │ map: 3.13 kB
-dist/mathjax/mathjax.cjs                        0.95 kB │ gzip: 0.51 kB │ map: 2.18 kB
-dist/audio/audio.cjs                            0.96 kB │ gzip: 0.51 kB │ map: 2.65 kB
-dist/iframe/iframe.cjs                          1.25 kB │ gzip: 0.57 kB │ map: 3.52 kB
-dist/heading/heading.cjs                        1.28 kB │ gzip: 0.64 kB │ map: 3.58 kB
-dist/attachment/attachment.cjs                  1.45 kB │ gzip: 0.69 kB │ map: 3.92 kB
-dist/linker/linker.cjs                          1.57 kB │ gzip: 0.75 kB │ map: 5.23 kB
-dist/index.cjs                                  1.87 kB │ gzip: 0.60 kB │ map: 0.09 kB
-dist/speech-recognition/speech-recognition.cjs  1.90 kB │ gzip: 0.79 kB │ map: 5.09 kB
-dist/video/video.cjs                            2.31 kB │ gzip: 0.90 kB │ map: 6.32 kB
-dist/image/custom-image.cjs                     2.90 kB │ gzip: 1.17 kB │ map: 7.95 kB
-✓ built in 4.09s

package/.turbo/turbo-format.log

@@ -1,142 +0,0 @@
- WARN  Issue while reading "/home/runner/work/edifice-ui/edifice-ui/.npmrc". Failed to replace env in config: ${NPM_TOKEN}
-
-> @edifice.io/tiptap-extensions@1.5.16-develop-rc.2 format /home/runner/work/edifice-ui/edifice-ui/packages/tiptap/extensions
-> pnpm run format:write && pnpm run format:check
-
- WARN  Issue while reading "/home/runner/work/edifice-ui/edifice-ui/.npmrc". Failed to replace env in config: ${NPM_TOKEN}
-
-> @edifice.io/tiptap-extensions@1.5.16-develop-rc.2 format:write /home/runner/work/edifice-ui/edifice-ui/packages/tiptap/extensions
-> npx prettier --write .
-
-dist/abbr/abbr.cjs 178ms
-dist/abbr/abbr.d.ts 596ms
-dist/abbr/abbr.js 29ms
-dist/abbr/index.d.ts 9ms (unchanged)
-dist/alert/alert.cjs 23ms
-dist/alert/alert.d.ts 29ms (unchanged)
-dist/alert/alert.js 35ms
-dist/alert/index.d.ts 3ms (unchanged)
-dist/attachment/attachment.cjs 79ms
-dist/attachment/attachment.d.ts 47ms
-dist/attachment/attachment.js 70ms
-dist/attachment/index.d.ts 2ms (unchanged)
-dist/audio/audio.cjs 45ms
-dist/audio/audio.d.ts 74ms
-dist/audio/audio.js 35ms
-dist/audio/index.d.ts 17ms (unchanged)
-dist/font-size/font-size.cjs 56ms
-dist/font-size/font-size.d.ts 21ms
-dist/font-size/font-size.js 22ms
-dist/font-size/index.d.ts 3ms (unchanged)
-dist/heading/heading.cjs 21ms
-dist/heading/heading.d.ts 41ms
-dist/heading/heading.js 18ms
-dist/heading/index.d.ts 2ms (unchanged)
-dist/highlight/highlight.cjs 5ms
-dist/highlight/highlight.d.ts 4ms
-dist/highlight/highlight.js 5ms
-dist/highlight/index.d.ts 2ms (unchanged)
-dist/hyperlink/hyperlink.cjs 11ms
-dist/hyperlink/hyperlink.d.ts 9ms
-dist/hyperlink/hyperlink.js 12ms
-dist/hyperlink/index.d.ts 2ms (unchanged)
-dist/iframe/iframe.cjs 52ms
-dist/iframe/iframe.d.ts 5ms
-dist/iframe/iframe.js 21ms
-dist/iframe/index.d.ts 2ms (unchanged)
-dist/image/custom-image.cjs 39ms
-dist/image/custom-image.d.ts 6ms
-dist/image/custom-image.js 35ms
-dist/image/index.d.ts 2ms (unchanged)
-dist/index.cjs 9ms
-dist/index.d.ts 3ms (unchanged)
-dist/index.js 4ms
-dist/line-height/index.d.ts 2ms (unchanged)
-dist/line-height/line-height.cjs 4ms
-dist/line-height/line-height.d.ts 3ms (unchanged)
-dist/line-height/line-height.js 9ms
-dist/linker/index.d.ts 5ms (unchanged)
-dist/linker/linker.cjs 20ms
-dist/linker/linker.d.ts 10ms
-dist/linker/linker.js 9ms
-dist/mathjax/index.d.ts 2ms (unchanged)
-dist/mathjax/mathjax.cjs 8ms
-dist/mathjax/mathjax.d.ts 4ms (unchanged)
-dist/mathjax/mathjax.js 6ms
-dist/paragraph/index.d.ts 2ms (unchanged)
-dist/paragraph/paragraph.cjs 3ms
-dist/paragraph/paragraph.d.ts 3ms
-dist/paragraph/paragraph.js 3ms
-dist/speech-recognition/index.d.ts 1ms (unchanged)
-dist/speech-recognition/speech-recognition.cjs 24ms
-dist/speech-recognition/speech-recognition.d.ts 18ms
-dist/speech-recognition/speech-recognition.js 24ms
-dist/speech-synthesis/index.d.ts 1ms (unchanged)
-dist/speech-synthesis/speech-synthesis.cjs 6ms
-dist/speech-synthesis/speech-synthesis.d.ts 5ms
-dist/speech-synthesis/speech-synthesis.js 5ms
-dist/table-cell/index.d.ts 2ms (unchanged)
-dist/table-cell/table-cell.cjs 5ms
-dist/table-cell/table-cell.d.ts 7ms
-dist/table-cell/table-cell.js 4ms
-dist/transform/html-to-json/html-to-json.cjs 2ms
-dist/transform/html-to-json/html-to-json.d.ts 2ms
-dist/transform/html-to-json/html-to-json.js 2ms
-dist/transform/index.d.ts 1ms (unchanged)
-dist/transform/json-to-html/json-to-html.cjs 2ms
-dist/transform/json-to-html/json-to-html.d.ts 7ms (unchanged)
-dist/transform/json-to-html/json-to-html.js 2ms
-dist/video/index.d.ts 9ms (unchanged)
-dist/video/video.cjs 19ms
-dist/video/video.d.ts 5ms
-dist/video/video.js 21ms
-package.json 10ms (unchanged)
-src/abbr/abbr.ts 38ms (unchanged)
-src/abbr/index.ts 3ms (unchanged)
-src/alert/alert.ts 7ms (unchanged)
-src/alert/index.ts 1ms (unchanged)
-src/attachment/attachment.ts 61ms (unchanged)
-src/attachment/index.ts 2ms (unchanged)
-src/audio/audio.ts 26ms (unchanged)
-src/audio/index.ts 13ms (unchanged)
-src/font-size/font-size.ts 22ms (unchanged)
-src/font-size/index.ts 11ms (unchanged)
-src/heading/heading.ts 43ms (unchanged)
-src/heading/index.ts 1ms (unchanged)
-src/highlight/highlight.ts 4ms (unchanged)
-src/highlight/index.ts 2ms (unchanged)
-src/hyperlink/hyperlink.ts 13ms (unchanged)
-src/hyperlink/index.ts 2ms (unchanged)
-src/iframe/iframe.ts 37ms (unchanged)
-src/iframe/index.ts 7ms (unchanged)
-src/image/custom-image.ts 99ms (unchanged)
-src/image/index.ts 2ms (unchanged)
-src/index.ts 6ms (unchanged)
-src/line-height/index.ts 2ms (unchanged)
-src/line-height/line-height.ts 5ms (unchanged)
-src/linker/index.ts 1ms (unchanged)
-src/linker/linker.ts 22ms (unchanged)
-src/mathjax/index.ts 1ms (unchanged)
-src/mathjax/mathjax.ts 25ms (unchanged)
-src/paragraph/index.ts 1ms (unchanged)
-src/paragraph/paragraph.ts 4ms (unchanged)
-src/speech-recognition/index.ts 2ms (unchanged)
-src/speech-recognition/speech-recognition.ts 38ms (unchanged)
-src/speech-synthesis/index.ts 1ms (unchanged)
-src/speech-synthesis/speech-synthesis.ts 16ms (unchanged)
-src/table-cell/index.ts 2ms (unchanged)
-src/table-cell/table-cell.ts 7ms (unchanged)
-src/transform/html-to-json/html-to-json.ts 2ms (unchanged)
-src/transform/index.ts 1ms (unchanged)
-src/transform/json-to-html/json-to-html.ts 2ms (unchanged)
-src/video/index.ts 1ms (unchanged)
-src/video/video.ts 41ms (unchanged)
-tsconfig.json 4ms (unchanged)
-vite.config.ts 46ms (unchanged)
- WARN  Issue while reading "/home/runner/work/edifice-ui/edifice-ui/.npmrc". Failed to replace env in config: ${NPM_TOKEN}
-
-> @edifice.io/tiptap-extensions@1.5.16-develop-rc.2 format:check /home/runner/work/edifice-ui/edifice-ui/packages/tiptap/extensions
-> npx prettier --check .
-
-Checking formatting...
-All matched files use Prettier code style!

package/.turbo/turbo-lint.log

@@ -1,5 +0,0 @@
- WARN  Issue while reading "/home/runner/work/edifice-ui/edifice-ui/.npmrc". Failed to replace env in config: ${NPM_TOKEN}
-
-> @edifice.io/tiptap-extensions@1.5.16-develop-rc.2 lint /home/runner/work/edifice-ui/edifice-ui/packages/tiptap/extensions
-> eslint "**/*.ts"
-

package/src/abbr/abbr.ts

@@ -1,57 +0,0 @@
-import { Mark, mergeAttributes } from '@tiptap/core';
-
-declare module '@tiptap/core' {
-  interface Commands<ReturnType> {
-    abbr: {
-      /**
-       * Set an abbr mark
-       */
-      setAbbr: (src: string) => ReturnType;
-      /**
-       * Toggle an abbr mark
-       */
-      toggleAbbr: (src: string) => ReturnType;
-    };
-  }
-}
-
-export const Abbr = Mark.create({
-  name: 'abbr',
-
-  addOptions() {
-    return {
-      HTMLAttributes: {},
-    };
-  },
-
-  parseHTML() {
-    return [
-      {
-        tag: 'abbr',
-      },
-    ];
-  },
-
-  renderHTML({ HTMLAttributes }) {
-    return [
-      'abbr',
-      mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
-      0,
-    ];
-  },
-
-  addCommands() {
-    return {
-      setAbbr:
-        () =>
-        ({ commands }) => {
-          return commands.setMark(this.name);
-        },
-      toggleAbbr:
-        () =>
-        ({ commands }) => {
-          return commands.toggleMark(this.name);
-        },
-    };
-  },
-});

package/src/abbr/index.ts

@@ -1,5 +0,0 @@
-import { Abbr } from './abbr';
-
-export * from './abbr';
-
-export default Abbr;

package/src/alert/alert.ts

@@ -1,46 +0,0 @@
-import { Node } from '@tiptap/core';
-
-export const Alert = Node.create({
-  name: 'alert',
-  content: 'inline+',
-  marks: '',
-  group: 'block',
-
-  inline: false,
-  selectable: true,
-  draggable: true,
-
-  parseHTML() {
-    return [
-      {
-        tag: 'p.info',
-        priority: 60,
-      },
-      {
-        tag: 'p.warning',
-        priority: 60,
-      },
-      {
-        tag: 'div.info',
-        priority: 60,
-      },
-      {
-        tag: 'div.warning',
-        priority: 60,
-      },
-    ];
-  },
-  addAttributes() {
-    return {
-      class: {
-        default: 'info',
-        parseHTML: (element) => {
-          return element.getAttribute('class');
-        },
-      },
-    };
-  },
-  renderHTML({ HTMLAttributes }) {
-    return ['div', HTMLAttributes, 0];
-  },
-});

package/src/alert/index.ts

@@ -1,5 +0,0 @@
-import { Alert } from './alert';
-
-export * from './alert';
-
-export default Alert;

package/src/attachment/attachment.ts

@@ -1,113 +0,0 @@
-import { Node } from '@tiptap/core';
-
-export interface AttachmentOptions {
-  HTMLAttributes: Record<string, string>;
-}
-
-declare module '@tiptap/core' {
-  interface Commands<ReturnType> {
-    attachment: {
-      setAttachment: (attachment) => ReturnType;
-    };
-  }
-}
-
-export const Attachment = Node.create<AttachmentOptions>({
-  name: 'attachments',
-  content: '',
-  marks: '',
-  group: 'block',
-  selectable: true,
-  atom: true,
-  draggable: true,
-
-  addOptions() {
-    return {
-      HTMLAttributes: {
-        class: 'attachments',
-      },
-    };
-  },
-
-  parseHTML() {
-    return [{ tag: 'div[class=attachments]' }];
-  },
-
-  renderHTML({ HTMLAttributes }) {
-    const links = HTMLAttributes.links;
-
-    const renderedLinks = links.map((el) => {
-      return [
-        'a',
-        {
-          name: el.name,
-          href: el.href,
-          documentId: el.documentId,
-          dataContentType: el.dataContentType,
-        },
-        el.name,
-      ];
-    });
-
-    return ['div', this.options.HTMLAttributes, ...renderedLinks];
-  },
-
-  addAttributes() {
-    return {
-      links: {
-        default: [],
-        parseHTML: (element) => {
-          const links = element.getElementsByTagName('a');
-          const parsedLinks = [];
-
-          for (let i = 0; i < links.length; i++) {
-            const link = links[i];
-            const href = link.getAttribute('href');
-            const name = link.textContent;
-            const regexResult = href.match(/([^/]+$)/);
-            const documentId =
-              link.getAttribute('data-document-id') ||
-              (regexResult && regexResult[0]);
-            const dataContentType = link.getAttribute('data-content-type');
-
-            parsedLinks.push({
-              href,
-              name,
-              documentId,
-              dataContentType,
-            });
-          }
-
-          return parsedLinks;
-        },
-        renderHTML: (attributes) => {
-          return {
-            links: attributes.links.map((link) => ({
-              href: link.href,
-              name: link.name,
-              documentId: link.documentId,
-              dataContentType: link.dataContentType,
-            })),
-          };
-        },
-      },
-    };
-  },
-
-  addCommands() {
-    return {
-      setAttachment:
-        (
-          attrs = {
-            dataContentType: '',
-            name: '',
-            documentId: '',
-            href: '',
-          },
-        ) =>
-        ({ chain }) => {
-          return chain().insertContent({ type: this.name, attrs }).run();
-        },
-    };
-  },
-});

package/src/attachment/index.ts

@@ -1,5 +0,0 @@
-import { Attachment } from './attachment';
-
-export * from './attachment';
-
-export default Attachment;

package/src/audio/audio.ts

@@ -1,81 +0,0 @@
-import { mergeAttributes, Node } from '@tiptap/core';
-
-export interface AudioOptions {
-  url: string;
-  HTMLAttributes: Record<string, any>;
-}
-
-declare module '@tiptap/core' {
-  interface Commands<ReturnType> {
-    audio: {
-      /**
-       * Set a audio node
-       * @param options.updateSelection set to true will select the newly inserted content
-       */
-      setAudio: (
-        id: string,
-        src: string,
-        options?: { updateSelection: boolean },
-      ) => ReturnType;
-    };
-  }
-}
-
-export const Audio = Node.create({
-  name: 'audio',
-
-  group: 'block',
-
-  addAttributes() {
-    return {
-      src: {
-        default: null,
-        parseHTML: (el: any) => (el as HTMLSpanElement).getAttribute('src'),
-        renderHTML: (attrs: any) => ({ src: attrs.src }),
-      },
-      documentId: {
-        default: '',
-        renderHTML: (attributes: any) => {
-          return { 'data-document-id': attributes.documentId };
-        },
-        parseHTML: (element: any) => element.getAttribute('data-document-id'),
-      },
-    };
-  },
-
-  parseHTML() {
-    return [
-      {
-        tag: 'div.audio-wrapper>audio,audio',
-        getAttrs: (el: any) => ({
-          src: (el as HTMLAudioElement).getAttribute('src'),
-        }),
-      },
-    ];
-  },
-
-  renderHTML({ HTMLAttributes }) {
-    return [
-      'div',
-      { class: 'audio-wrapper' },
-      ['audio', mergeAttributes(HTMLAttributes)],
-    ];
-  },
-
-  addCommands() {
-    return {
-      setAudio:
-        (id, src, options) =>
-        ({ commands, state }) => {
-          return commands.insertContentAt(
-            state.selection,
-            `<audio 
-              src="${src}" 
-              controls preload="none"
-              data-document-id="${id}"></audio>`,
-            options,
-          );
-        },
-    };
-  },
-});

package/src/audio/index.ts

@@ -1,5 +0,0 @@
-import { Audio } from './audio';
-
-export * from './audio';
-
-export default Audio;