Files
outline/shared/editor/nodes/Embed.tsx
Apoorv Mishra 4dbad4e46c feat: Support embed configuration (#3980)
* wip

* stash

* fix: make authenticationId nullable fk

* fix: apply generics to resolve compile time type errors

* fix: loosen integration settings

* chore: refactor into functional component

* feat: pass integrations all the way to embeds

* perf: avoid re-fetching integrations

* fix: change attr name to avoid type overlap

* feat: use hostname from embed settings in matcher

* Revert "feat: use hostname from embed settings in matcher"

This reverts commit e7485d9cda.

* feat: refactor  into a class

* chore: refactor url regex formation as a util

* fix: escape regex special chars

* fix: remove in-house escapeRegExp in favor of lodash's

* fix: sanitize url

* perf: memoize embeds

* fix: rename hostname to url and allow spreading entire settings instead of just url

* fix: replace diagrams with drawio

* fix: rename

* fix: support self-hosted and saas both

* fix: assert on settings url

* fix: move embed integrations loading to hook

* fix: address review comments

* fix: use observer in favor of explicit state setters

* fix: refactor useEmbedIntegrations into useEmbeds

* fix: use translations for toasts

Co-authored-by: Tom Moor <tom.moor@gmail.com>
2022-08-26 12:21:46 +05:30

149 lines
3.6 KiB
TypeScript

import Token from "markdown-it/lib/token";
import { NodeSpec, NodeType, Node as ProsemirrorNode } from "prosemirror-model";
import { EditorState } from "prosemirror-state";
import * as React from "react";
import { sanitizeUrl } from "../../utils/urls";
import DisabledEmbed from "../components/DisabledEmbed";
import { MarkdownSerializerState } from "../lib/markdown/serializer";
import embedsRule from "../rules/embeds";
import { ComponentProps, Dispatch } from "../types";
import Node from "./Node";
const cache = {};
export default class Embed extends Node {
get name() {
return "embed";
}
get schema(): NodeSpec {
return {
content: "inline*",
group: "block",
atom: true,
attrs: {
href: {},
},
parseDOM: [
{
tag: "iframe.embed",
getAttrs: (dom: HTMLIFrameElement) => {
const { embeds } = this.editor.props;
const href = dom.getAttribute("src") || "";
if (embeds) {
for (const embed of embeds) {
const matches = embed.matcher(href);
if (matches) {
return {
href,
};
}
}
}
return {};
},
},
],
toDOM: (node) => [
"iframe",
{
class: "embed",
src: sanitizeUrl(node.attrs.href),
contentEditable: "false",
},
0,
],
toPlainText: (node) => node.attrs.href,
};
}
get rulePlugins() {
return [embedsRule(this.options.embeds)];
}
component({ isEditable, isSelected, theme, node }: ComponentProps) {
const { embeds, embedsDisabled } = this.editor.props;
// matches are cached in module state to avoid re running loops and regex
// here. Unfortunately this function is not compatible with React.memo or
// we would use that instead.
const hit = cache[node.attrs.href];
let Component = hit ? hit.Component : undefined;
let matches = hit ? hit.matches : undefined;
let embed = hit ? hit.embed : undefined;
if (!Component) {
for (const e of embeds) {
const m = e.matcher(node.attrs.href);
if (m) {
Component = e.component;
matches = m;
embed = e;
cache[node.attrs.href] = { Component, embed, matches };
}
}
}
if (!Component) {
return null;
}
if (embedsDisabled) {
return (
<DisabledEmbed
attrs={{ href: node.attrs.href, matches }}
embed={embed}
isEditable={isEditable}
isSelected={isSelected}
theme={theme}
/>
);
}
return (
<Component
attrs={{ ...node.attrs, matches }}
isEditable={isEditable}
isSelected={isSelected}
embed={embed}
theme={theme}
/>
);
}
commands({ type }: { type: NodeType }) {
return (attrs: Record<string, any>) => (
state: EditorState,
dispatch: Dispatch
) => {
dispatch(
state.tr.replaceSelectionWith(type.create(attrs)).scrollIntoView()
);
return true;
};
}
toMarkdown(state: MarkdownSerializerState, node: ProsemirrorNode) {
state.ensureNewLine();
state.write(
"[" +
state.esc(node.attrs.href, false) +
"](" +
state.esc(node.attrs.href, false) +
")"
);
state.write("\n\n");
}
parseMarkdown() {
return {
node: "embed",
getAttrs: (token: Token) => ({
href: token.attrGet("href"),
}),
};
}
}