@lowdefy/blocks-tiptap 0.0.0-experimental-20260428103147

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1 @@
+# @lowdefy/blocks-tiptap

package/dist/blocks/TiptapInput/TiptapInput.js

@@ -0,0 +1,170 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import React, { useEffect } from 'react';
+import { withBlockDefaults } from '@lowdefy/block-utils';
+import { type } from '@lowdefy/helpers';
+import { useEditor, EditorContent } from '@tiptap/react';
+import Label from '@lowdefy/blocks-antd/blocks/Label/Label.js';
+import PopoverMenu from '../utils/PopoverMenu.js';
+import buildExtensions from '../utils/buildExtensions.js';
+import computeHeightStyle from '../utils/computeHeightStyle.js';
+import statusClass from '../utils/statusClass.js';
+import useTiptapState from './useTiptapState.js';
+import './style.module.css';
+const TiptapInput = ({ blockId, components: { Icon, Link }, events, loading, methods, properties, required, validation, value })=>{
+    const { emit, insertImage } = useTiptapState({
+        value,
+        methods
+    });
+    const disabled = properties.disabled === true || loading;
+    const uploadEnabled = !type.isNone(properties.s3PostPolicyRequestId);
+    const extensions = buildExtensions({
+        properties,
+        insertImage,
+        uploadEnabled
+    });
+    const heightStyle = computeHeightStyle({
+        rows: properties.rows,
+        autoSize: properties.autoSize
+    });
+    const editor = useEditor({
+        extensions,
+        content: value?.html || '',
+        editable: ()=>!disabled,
+        onUpdate ({ editor }) {
+            // User-driven change. Emit the full derived value to Lowdefy.
+            emit(editor);
+            methods.triggerEvent({
+                name: 'onChange'
+            });
+        }
+    });
+    // Register upload-policy event once (if configured).
+    useEffect(()=>{
+        if (!uploadEnabled) return;
+        methods.registerEvent({
+            name: '__getS3PostPolicy',
+            actions: [
+                {
+                    id: '__getS3PostPolicy',
+                    type: 'Request',
+                    params: [
+                        properties.s3PostPolicyRequestId
+                    ]
+                }
+            ]
+        });
+    }, []);
+    // Register methods as soon as the editor is available.
+    useEffect(()=>{
+        if (!editor) return;
+        methods.registerMethod('clear', ()=>{
+            editor.commands.clearContent();
+            emit(editor);
+        });
+        methods.registerMethod('setContent', (args)=>{
+            editor.commands.setContent(args?.html ?? '');
+            emit(editor);
+        });
+        methods.registerMethod('focus', ()=>{
+            editor.commands.focus();
+        });
+    }, [
+        editor
+    ]);
+    // External value.html → editor sync. One-way only: we read value.html and
+    // push it into the editor with setContent(..., false) so tiptap's onUpdate
+    // does not fire. No write-back via emit() — that would race with concurrent
+    // SetState calls (child effects fire before parent effects, so a sibling's
+    // onMount SetState could be overwritten by our derived emit). Derived
+    // fields (text/markdown/fileList) are populated on user interaction via
+    // onUpdate; downstream consumers of seeded content should read value.html
+    // directly, or include the fields they need in their SetState payload.
+    useEffect(()=>{
+        if (!editor) return;
+        const next = value?.html ?? '';
+        const current = editor.getHTML();
+        if (next !== current) {
+            editor.commands.setContent(next, false);
+        }
+    }, [
+        value?.html,
+        editor
+    ]);
+    useEffect(()=>{
+        if (!editor) return;
+        editor.setOptions({
+            editable: !disabled
+        });
+    }, [
+        editor,
+        disabled
+    ]);
+    useEffect(()=>{
+        if (!editor) return;
+        const placeholderExt = editor.extensionManager.extensions.find((extension)=>extension.name === 'placeholder');
+        if (placeholderExt) {
+            placeholderExt.options.placeholder = properties.placeholder ?? '';
+            editor.view.dispatch(editor.state.tr);
+        }
+    }, [
+        editor,
+        properties.placeholder
+    ]);
+    const wrapperClass = [
+        'tiptap-wrapper',
+        properties.bordered === false ? 'tiptap-wrapper-borderless' : '',
+        disabled ? 'tiptap-wrapper-disabled' : '',
+        statusClass(validation?.status)
+    ].filter(Boolean).join(' ');
+    const wrapperStyle = {
+        padding: 0,
+        ...heightStyle,
+        ...properties.inputStyle,
+        ...properties.style
+    };
+    return /*#__PURE__*/ React.createElement(Label, {
+        blockId: blockId,
+        components: {
+            Icon,
+            Link
+        },
+        events: events,
+        properties: {
+            title: properties.title,
+            size: properties.size,
+            ...properties.label
+        },
+        required: required,
+        validation: validation,
+        content: {
+            content: ()=>{
+                if (!editor) {
+                    return /*#__PURE__*/ React.createElement("div", null);
+                }
+                return /*#__PURE__*/ React.createElement(React.Fragment, null, /*#__PURE__*/ React.createElement(EditorContent, {
+                    id: `${blockId}_input`,
+                    editor: editor,
+                    className: wrapperClass,
+                    style: wrapperStyle
+                }), !disabled && /*#__PURE__*/ React.createElement(PopoverMenu, {
+                    editor: editor,
+                    Icon: Icon
+                }));
+            }
+        }
+    });
+};
+export default withBlockDefaults(TiptapInput);

package/dist/blocks/TiptapInput/e2e.js

@@ -0,0 +1,25 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ import { createBlockHelper, escapeId } from '@lowdefy/e2e-utils';
+import { expect } from '@playwright/test';
+const locator = (page, blockId)=>page.locator(`#${escapeId(blockId)}_input .ProseMirror`).first();
+export default createBlockHelper({
+    locator,
+    expect: {
+        containsText: (page, blockId, text)=>expect(locator(page, blockId)).toContainText(text),
+        containsHtml: (page, blockId, selector)=>expect(locator(page, blockId).locator(selector)).toBeVisible(),
+        isEmpty: (page, blockId)=>expect(locator(page, blockId)).toHaveText('')
+    }
+});

package/dist/blocks/TiptapInput/meta.js

@@ -0,0 +1,212 @@
+/*
+  Copyright 2020-2026 Lowdefy, Inc
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/ export default {
+    category: 'input',
+    icons: [],
+    valueType: 'object',
+    initValue: {
+        html: null,
+        text: null,
+        markdown: null,
+        fileList: []
+    },
+    events: {
+        onChange: 'Trigger action when the editor content is changed.'
+    },
+    properties: {
+        type: 'object',
+        additionalProperties: false,
+        properties: {
+            allowedMimeTypes: {
+                type: 'array',
+                items: {
+                    type: 'string'
+                },
+                description: 'Mime-types accepted by the drag/drop and paste file handler. Defaults to common image types (jpeg, png, gif, webp). Only used when s3PostPolicyRequestId is set.'
+            },
+            autoSize: {
+                oneOf: [
+                    {
+                        type: 'boolean',
+                        default: false,
+                        description: 'When true the editor grows with its content and has no max height.'
+                    },
+                    {
+                        type: 'object',
+                        description: 'Constrain the editor height with a minimum and/or maximum row count.',
+                        properties: {
+                            minRows: {
+                                type: 'integer',
+                                minimum: 1,
+                                description: 'Minimum visible rows before content overflows.'
+                            },
+                            maxRows: {
+                                type: 'integer',
+                                minimum: 1,
+                                description: 'Maximum visible rows; beyond this the editor scrolls vertically.'
+                            }
+                        }
+                    }
+                ],
+                description: 'Either a boolean (true to auto-grow without a cap) or an object with minRows/maxRows. Ignored when `rows` is set.'
+            },
+            bordered: {
+                type: 'boolean',
+                default: true,
+                description: 'Whether the editor renders with a border.'
+            },
+            disabled: {
+                type: 'boolean',
+                default: false,
+                description: 'Render the editor as read-only.'
+            },
+            highlight: {
+                type: 'object',
+                description: 'Text highlight extension settings.',
+                additionalProperties: false,
+                properties: {
+                    disabled: {
+                        type: 'boolean',
+                        default: false,
+                        description: 'Disable the Highlight extension and its bubble-menu color swatches.'
+                    },
+                    multicolor: {
+                        type: 'boolean',
+                        default: true,
+                        description: 'Allow highlights to carry a color value. Disable for single-color.'
+                    }
+                }
+            },
+            image: {
+                type: 'object',
+                description: 'Image extension settings.',
+                additionalProperties: false,
+                properties: {
+                    disabled: {
+                        type: 'boolean',
+                        default: false,
+                        description: 'Disable the Image extension.'
+                    },
+                    maxWidth: {
+                        type: 'string',
+                        default: '80%',
+                        description: 'Inline CSS max-width applied to inserted images.'
+                    },
+                    zoom: {
+                        type: 'number',
+                        default: 0.5,
+                        description: 'Inline CSS zoom factor applied to inserted images.'
+                    }
+                }
+            },
+            inputStyle: {
+                type: 'object',
+                description: 'Inline style applied to the editable area of the editor.',
+                docs: {
+                    displayType: 'yaml'
+                }
+            },
+            label: {
+                type: 'object',
+                description: 'Label configuration forwarded to the Lowdefy Label block.',
+                docs: {
+                    displayType: 'yaml'
+                }
+            },
+            link: {
+                type: 'object',
+                description: 'Link extension settings.',
+                additionalProperties: false,
+                properties: {
+                    disabled: {
+                        type: 'boolean',
+                        default: false,
+                        description: 'Disable the Link extension.'
+                    },
+                    autolink: {
+                        type: 'boolean',
+                        default: true,
+                        description: 'Auto-convert URLs typed in the editor to links.'
+                    },
+                    linkOnPaste: {
+                        type: 'boolean',
+                        default: true,
+                        description: 'Convert pasted URLs to links.'
+                    },
+                    openOnClick: {
+                        type: 'boolean',
+                        default: true,
+                        description: 'Open links in a new tab when clicked in view mode.'
+                    },
+                    defaultProtocol: {
+                        type: 'string',
+                        default: 'https',
+                        description: 'Protocol prefixed to URLs that omit one (e.g. "https").'
+                    }
+                }
+            },
+            placeholder: {
+                type: 'string',
+                description: 'Placeholder shown when the editor is empty.'
+            },
+            rows: {
+                type: 'integer',
+                minimum: 1,
+                description: 'Fix the editor height to exactly this many rows. Takes precedence over autoSize.'
+            },
+            s3PostPolicyRequestId: {
+                type: 'string',
+                description: 'Id of a request that returns an S3 presigned POST policy. When set, images dragged or pasted into the editor are uploaded via that policy and inserted as <img> nodes. Leave unset to disable image uploads.'
+            },
+            size: {
+                type: 'string',
+                enum: [
+                    'small',
+                    'middle',
+                    'large'
+                ],
+                description: 'Label size forwarded to the Label block.'
+            },
+            starterKit: {
+                type: 'object',
+                description: 'Options forwarded to TipTap StarterKit (https://tiptap.dev/docs/editor/extensions/functionality/starterkit). Use this to disable bundled extensions (e.g. {heading: false, codeBlock: false}).',
+                docs: {
+                    displayType: 'yaml'
+                }
+            },
+            table: {
+                type: 'object',
+                description: 'Table extension settings.',
+                additionalProperties: false,
+                properties: {
+                    disabled: {
+                        type: 'boolean',
+                        default: false,
+                        description: 'Disable the Table extension and its row/header/cell nodes.'
+                    },
+                    resizable: {
+                        type: 'boolean',
+                        default: true,
+                        description: 'Allow column resizing with a drag handle.'
+                    }
+                }
+            },
+            title: {
+                type: 'string',
+                description: 'Label title shown above the editor.'
+            }
+        }
+    }
+};

package/dist/blocks/TiptapInput/style.module.css

@@ -0,0 +1,60 @@
+@import '../utils/style.module.css';
+
+:global(.tableWrapper),
+:global(.tiptap-table) {
+  display: block;
+  overflow-x: auto;
+  max-width: 80%;
+}
+
+:global(.tableWrapper) :global(table),
+:global(.tiptap-table) :global(table) {
+  border-collapse: collapse;
+  width: 100%;
+  min-width: 75px;
+}
+
+:global(.tableWrapper) :global(colgroup) :global(col),
+:global(.tiptap-table) :global(colgroup) :global(col) {
+  width: auto;
+}
+
+:global(.tableWrapper) :global(table),
+:global(.tableWrapper) :global(th),
+:global(.tableWrapper) :global(td),
+:global(.tiptap-table) :global(table),
+:global(.tiptap-table) :global(th),
+:global(.tiptap-table) :global(td) {
+  border: 1px solid var(--ant-color-border);
+}
+
+:global(.tableWrapper) :global(th),
+:global(.tableWrapper) :global(td),
+:global(.tiptap-table) :global(th),
+:global(.tiptap-table) :global(td) {
+  padding: 2px;
+  text-align: left;
+}
+
+:global(.tableWrapper) :global(th),
+:global(.tiptap-table) :global(th) {
+  background-color: var(--ant-color-fill-tertiary);
+  font-weight: bold;
+}
+
+:global(.tableWrapper) :global(tr):nth-child(even),
+:global(.tiptap-table) :global(tr):nth-child(even) {
+  background-color: var(--ant-color-fill-quaternary);
+}
+
+:global(.tableWrapper) :global(tr):hover,
+:global(.tiptap-table) :global(tr):hover {
+  background-color: var(--ant-color-primary-bg);
+}
+
+:global(.tableWrapper) :global(td) :global(p),
+:global(.tableWrapper) :global(th) :global(p),
+:global(.tiptap-table) :global(td) :global(p),
+:global(.tiptap-table) :global(th) :global(p) {
+  margin: 0;
+}