@lyads/visual-editor 0.0.0-stage → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 1.0.1
+
+Primeira versão pública.
+
+- Editor de documentos HTML (schema 1) com modo visual e modo código sobre o mesmo histórico,
+  importação tolerante e preservação do HTML não reconhecido.
+- Peças em blocos (schema 2) com estilos globais, painel de propriedades gerado das definições,
+  saída MJML para e-mail e HTML/CSS para página, e conversão para documento HTML.
+- Edição de texto no lugar, teclado, arraste com linha de inserção, ferramentas de imagem.
+- Valores só do celular, ocultar por dispositivo e ordem invertida de colunas.
+- Conferência antes de enviar, prévia escura aproximada e variáveis como etiqueta.
+- Modelos em português, inglês e espanhol; blocos salvos pelo host.
+- Kit de servidor para validar peças e compilar MJML num worker Node contido.

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/NOTICE

@@ -0,0 +1,8 @@
+@lyads/visual-editor
+Copyright 2026 Gabriel Silva (https://github.com/oGabrielSilva)
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+"Lyads" is a trademark of its owner; the license grants no right to use it
+(section 6 of the Apache License).
+
+Third-party dependencies keep their own licenses, listed in THIRD_PARTY_NOTICES.md.

package/README.md

@@ -1,3 +1,136 @@
-# Temporary Holding Version
+# @lyads/visual-editor
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Editor visual de e-mails e landing pages para Vue 3. A pessoa edita o texto direto na peça,
+arrasta e reorganiza blocos, troca imagens e alterna para o código HTML sem perder o trabalho.
+O e-mail é gerado com MJML; a página, com HTML e CSS próprios.
+
+O pacote é só o editor. Quem o integra (o *host*) decide onde a peça fica guardada, quem pode
+editá-la, de onde vêm as imagens e as variáveis, e como a peça é enviada ou publicada.
+
+## Recursos
+
+- **Dois formatos de documento.**
+  - *Documento HTML* (schema 1): uma árvore HTML validada, editável no modo visual e no modo
+    código sobre o mesmo histórico. HTML importado é preservado; o que o editor não reconhece
+    continua editável no código.
+  - *Peça em blocos* (schema 2): seções, colunas, texto, título, imagem, botão, divisor,
+    espaçador, rodapé, formulário e HTML livre, cada um com suas propriedades num lugar só, e
+    estilos globais herdados. O e-mail é gerado com MJML a cada salvamento.
+- **Edição no lugar**, com barra de formatação (negrito, itálico, links, cor, fonte, tamanho,
+  listas), colagem limpa e variáveis do host mostradas como etiqueta.
+- **Teclado e mouse**: selecionar, mover, duplicar, remover, desfazer e refazer por atalho;
+  arrastar com linha de inserção e rolagem automática.
+- **Celular e computador**: valores só de telas pequenas, ocultar um bloco por tela e ordem
+  invertida de colunas no celular.
+- **Conferência antes de enviar**: links vazios, imagens sem texto alternativo, botões sem
+  link e e-mails acima do corte de 102 KB do Gmail.
+- **Prévia escura** aproximada, modelos em português, inglês e espanhol, e blocos salvos pelo
+  host para reaproveitar.
+
+## Instalação
+
+Requer Node 22.12 ou superior.
+
+```bash
+npm install @lyads/visual-editor
+```
+
+Vue 3.5 e Vue Router são dependências compartilhadas com o seu aplicativo. Site do projeto:
+<https://ogabrielsilva.github.io/visual-editor/>.
+
+## Uso
+
+### Peça em blocos
+
+```ts
+import { createBlockEditor } from '@lyads/visual-editor';
+import { BlockVisualEditor } from '@lyads/visual-editor/vue';
+import '@lyads/visual-editor/styles.css';
+
+const editor = createBlockEditor({
+  kind: 'email', // ou 'page'
+  language: 'pt-BR', // textos iniciais: pt-BR, en ou es
+  store: {
+    // Recebe a peça (JSON) e a saída gerada; responde com a nova revisão.
+    async save(document, output, expectedRevision) {
+      return { revision: document.revision };
+    },
+  },
+});
+```
+
+```vue
+<BlockVisualEditor
+  :controller="editor.controller"
+  :selection-renderer="editor.selectionRenderer"
+  :image-picker="imagePicker"
+  :saved-blocks="savedBlocks"
+  :variables="variables"
+/>
+```
+
+Ao desmontar, chame `editor.dispose()`.
+
+### Documento HTML
+
+```ts
+import { createEditor } from '@lyads/visual-editor';
+import { VisualEditor } from '@lyads/visual-editor/vue';
+
+const editor = createEditor({
+  kind: 'page',
+  source: { html: '<h1>Seu próximo passo</h1>', css: '' },
+  host: { store: documentStore },
+});
+```
+
+### No servidor
+
+`@lyads/visual-editor/server` não importa nada de Vue. Use-o para validar o que o cliente
+envia e gerar a saída final no servidor, que é a fonte da verdade:
+
+```ts
+import { createServerBlockToolkit } from '@lyads/visual-editor/server';
+
+const toolkit = createServerBlockToolkit();
+const parsed = toolkit.parse(input); // valida a peça; lança erro se for inválida
+if (parsed.schemaVersion === 2) {
+  const output = await toolkit.render(parsed.document); // HTML do e-mail, ou HTML e CSS da página
+}
+```
+
+A compilação MJML roda num worker Node com tempo e memória limitados.
+
+### Portas do host
+
+| Porta | Para quê |
+| --- | --- |
+| `store` | Guardar a peça com controle de revisão (o host faz a concorrência). |
+| `imagePicker` | Escolher ou enviar imagens da biblioteca do host. |
+| `savedBlocks` | Listar, salvar e remover blocos reaproveitáveis. |
+| `variables` | Catálogo de variáveis (`{{contact.firstName}}`) com nomes amigáveis. |
+| `messages` | Textos da interface; o padrão é pt-BR. |
+
+## Segurança
+
+O conteúdo da peça roda num iframe isolado, sem acesso à página do editor. E-mails têm scripts,
+handlers e endereços de código removidos. **Páginas não são sanitizadas**: o HTML do autor sai
+como foi escrito, scripts incluídos. Se você publicar a saída de uma página, sirva-a numa origem
+separada da do seu aplicativo. Leia [docs/security.md](docs/security.md) antes de integrar e
+[SECURITY.md](SECURITY.md) para relatar vulnerabilidades.
+
+## Limites
+
+- MJML melhora muito a compatibilidade, mas a renderização em clientes reais de e-mail
+  (Outlook, Gmail, Apple Mail) não é certificada pelo pacote.
+- A prévia escura é uma aproximação: cada cliente escurece de um jeito.
+- Leitores de tela e aparelhos físicos não fazem parte dos testes automatizados.
+
+## Desenvolvimento
+
+Veja [CONTRIBUTING.md](CONTRIBUTING.md) e a [arquitetura](docs/architecture.md).
+
+## Licença
+
+Apache License 2.0: veja [LICENSE](LICENSE) e [NOTICE](NOTICE). A licença não dá direito de uso da marca Lyads. As dependências de terceiros mantêm suas licenças, listadas em
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).