@alitons/ckeditor5 0.0.2

package/LICENSE.md

@@ -0,0 +1,49 @@
+Software License Agreement
+==========================
+
+Copyright (c) 2014-2023, CKSource Holding sp. z o.o. All rights reserved.
+
+Online builder code samples are licensed under the terms of the MIT License (see Appendix A):
+
+	http://en.wikipedia.org/wiki/MIT_License
+
+CKEditor 5 collaboration features are only available under a commercial license. [Contact us](https://ckeditor.com/contact/) for more details.
+
+Free 30-days trials of CKEditor 5 collaboration features are available:
+ * https://ckeditor.com/collaboration/ - Real-time collaboration (with all features).
+ * https://ckeditor.com/collaboration/comments/ - Inline comments feature (without real-time collaborative editing).
+ * https://ckeditor.com/collaboration/track-changes/ - Track changes feature (without real-time collaborative editing).
+
+Trademarks
+----------
+
+CKEditor is a trademark of CKSource Holding sp. z o.o. All other brand
+and product names are trademarks, registered trademarks or service
+marks of their respective holders.
+
+---
+
+Appendix A: The MIT License
+---------------------------
+
+The MIT License (MIT)
+
+Copyright (c) 2014-2023, CKSource Holding sp. z o.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,262 @@
+
+# CkEditor + Plugins SEI, AutoTexto e Documento Modelo
+
+### 💻 Requisitos
+**Bootstrap:** 5.x (Opcional)
+
+## Modo de usar
+
+Importe o Bootstrap em seu projeto
+
+Adicione o diretório build (desse repositório)
+
+``` html
+...
+<script src="../build/ckeditor.js"></script>
+...
+```
+
+Adicione ao seu HTML no para exibir o editor
+
+```html
+<div class="row">
+    <div class="col-12">
+        <div class="document-editor__toolbar"></div>
+    </div>
+    <div class="col-12  row-editor">
+        <div class="editor-container">
+            <div class="editor">
+                
+            </div>
+        </div>
+    </div>
+</div>
+```
+
+Nesse exemplo, foi levado em consideração o uso do Bootstrap.
+
+No html é necessário apenas 2 divs. Uma div onde será exibido o toolbar, no caso do exemplo acima está identificado pela classe `.document-editor__toolbar`. Outra classe onde será exibido o editor, nesse exemplo identificado pela classe `.editor`
+
+
+Para inicializar o editor:
+ - Instancie o CKEditor usando o metodo `EditorWatchdog`. 
+ - Adicione o toolbar usando o metodo `setCreator`.
+ - Inicie o editor usando o metodo `create`.
+
+Veja um código de exemplo abaixo:
+
+```javascript
+const watchdog = new CKSource.EditorWatchdog();
+
+watchdog.setCreator( ( element, config ) => {
+	return CKSource.Editor
+    .create( element, config )
+    .then( editor => {
+        document.querySelector( '.document-editor__toolbar' ).appendChild( editor.ui.view.toolbar.element );
+        document.querySelector( '.ck-toolbar' ).classList.add( 'ck-reset_all' );
+
+        return editor;
+    });
+});
+
+watchdog.create( document.querySelector( '.editor' ), {
+	toolbar: {
+		autoTextoOptions: {
+			ajax: {
+				url: 'http://url-da-api-autotexto',
+				method: 'GET'
+			}
+		},
+		documentoModeloOptions: {
+            categoria: {
+                ajax: {
+                    url: 'http://url-da-api-da-categoria-de-modelos',
+                    method: 'GET'
+                },
+            },
+            ajax: {
+				url: 'http://url-da-api-dos-modelos',
+				method: 'GET'
+			}
+		},
+		seiOptions: {
+			url: 'http://url-da-api-sei',
+			resultData: 'data[0].autotexto',
+		},
+		items: [
+			'heading',
+			'|',
+			'bold',
+			'italic',
+			'link',
+			'bulletedList',
+			'numberedList',
+			'|',
+			'undo',
+			'redo',
+			'|',
+			'autotexto',
+			'importarsei',
+			'documentoModelo'
+		]
+	},
+})
+```
+
+Para adicionar os plugins em seu editor você deve informar no toolbar os itens `autotexto`, `importarsei` e `documentoModelo`. Além disso é necessário criar uma objeto com as configurações de cada um deles, caso o contrário o botão ficará desabilitado.
+
+### 🔧 Configurações dos plugins AutoTexto e Documento Modelo
+
+As opções de textos podem ser definidas através de uma requisição ajax ou até mesmo já iniciados com o plugin.
+
+O plugin `AutoTexto` e `documentoModelo` tem as seguintes opções
+
+| Chave   | Valor       | Obrigatório       | Descrição                           |
+| :---------- | :--------- | :--------- |:---------------------------------- |
+| options | Array | `false` Obrigatório se não tiver o parametro ajax | Um array de objetos com os valores dos autotextos desejados |
+| ajax | Object | `false` Obrigatório se não tiver o parametro options | Um  objetos com as informações da requisição ajax |
+
+Caso você não informe um dos 2 parametros acima o botão irá ficar inativo
+
+#### Informando valores de forma manual
+
+O atributo `options` precisa ser um array com os itens que poderam ser selecionados. Veja um exemplo abaixo:
+
+```
+...
+toolbar: {
+    ...
+
+    autoTextoOptions: {
+        options: [
+            {
+                autotexto: '<p>Conteúdo do autotexto 1</p>',
+                titulo: 'Título do autotexto 2'
+            },
+            {
+                autotexto: '<p>Conteúdo do autotexto 2</p>',
+                titulo: 'Título do autotexto 1'
+            }
+            ...
+        ]
+    }
+    ...
+}
+...
+```
+
+onde:
+
+| parametro | Valor | Obrigatórios | Descrição
+| :-- | :-- | :-- | :--
+| autotexto | String | `true` | Valor que será adiciona ao editor quando a opção for selecionada
+| titulo | String | `true` | Valor que será exibido no option` para identificar o autotexto.
+
+#### Informando valores com o uso de autoTextoOptions
+
+Informe no atributo `ajax` as informações da sua API
+
+| Chave | Valor | Obrigatório | Descrição
+| :-- | :-- | :-- | :--
+| url | String | `true` |  O endereço da sua API
+| method | String | `false` | Metodo que sua requisição será chamada podendo ser `GET` ou `POST`. Caso não seja informado será usado `GET`
+| data | Object | `false` | Nesse campo você pode enviar valores para serem enviados na requisição. Por exemplo, você precisa identificar o id do usuário envie `{ id_usuario: 1}`
+| results | Object | `false` | Informe em quais atributos os valores serão retornado. Por exemplo, você deseja o atributo nome dese ser o título e o atributo conteúdo deve ser o autotexto `{autotexto: 'conteudo', titulo: 'nome'}`
+
+
+### 🔧 Configurações dos plugin SEI
+
+O plugin do SEI tem apenas o tributo `ajax` com as seguintes atributos.
+
+| Chave | Valor | Obrigatório | Descrição
+| :-- | :-- | :-- | :--
+| url | String | `true` | Endereço da API
+| method | String | `false` | Metodo que sua requisição será chamada podendo ser `GET` ou `POST`. Caso não seja informado será usado `GET`
+| resultData | String | `false` | Atributo onde estará o valor do autotexto.
+| erros | Object | `false` | Mensagem de erros de acordo com o código da resposta HTTP.
+
+#### Exemplo das mensagens de erro.
+
+```
+...
+erros: {
+    '404': 'Nenhum documento encontrado',
+    '500': 'Ocorreu um erro interno. Tente novamente em 1 hora'
+}
+...
+```
+
+## Exemplo de retorno de uma requisição ajax.
+
+**api.php**
+```
+{
+    "current_page": 1,
+    "data": [
+        {
+            "id_autotexto": 4,
+            "id_categoria_autotexto": 1,
+            "id_usuario": null,
+            "id_lotacao": null,
+            "id_orgao": null,
+            "titulo": "Justificativa",
+            "descricao": "",
+            "autotexto": "<ol><li>A contrata\u00e7\u00e3o pretendida mostra-se vi\u00e1vel, atende adequadamente \u00e0s demandas de neg\u00f3cio formuladas, as diretrizes do normativo, os benef\u00edcios pretendidos s\u00e3o adequados, os custos previstos s\u00e3o compat\u00edveis e caracterizam a economicidade, os riscos envolvidos s\u00e3o administr\u00e1veis e a \u00e1rea requisitante priorizar\u00e1 o fornecimento de todos os elementos aqui relacionados necess\u00e1rios \u00e0 consecu\u00e7\u00e3o dos benef\u00edcios pretendidos, pelo que recomendo vi\u00e1vel a contrata\u00e7\u00e3o.<\/li><\/ol>",
+            "id_usuario_cadastro": null,
+            "data_cadastro": null,
+            "id_usuario_ultima_alteracao": null,
+            "data_ultima_alteracao": null,
+            "id_usuario_exclusao": null,
+            "data_exclusao": null
+        },
+        {
+            "id_autotexto": 5,
+            "id_categoria_autotexto": 1,
+            "id_usuario": null,
+            "id_lotacao": null,
+            "id_orgao": null,
+            "titulo": "Teste2",
+            "descricao": null,
+            "autotexto": "Teste",
+            "id_usuario_cadastro": null,
+            "data_cadastro": null,
+            "id_usuario_ultima_alteracao": null,
+            "data_ultima_alteracao": null,
+            "id_usuario_exclusao": null,
+            "data_exclusao": null
+        }
+    ],
+    "first_page_url": "http:\/\/url-api\/api\/teste?page=1",
+    "from": 1,
+    "last_page": 1,
+    "last_page_url": "http:\/\/url-api\/api\/teste?page=1",
+    "links": [
+        {
+            "url": null,
+            "label": "pagination.previous",
+            "active": false
+        },
+        {
+            "url": "http:\/\/url-api\/api\/teste?page=1",
+            "label": "1",
+            "active": true
+        },
+        {
+            "url": null,
+            "label": "pagination.next",
+            "active": false
+        }
+    ],
+    "next_page_url": null,
+    "path": "http:\/\/url-api\/api\/teste",
+    "per_page": 10,
+    "prev_page_url": null,
+    "to": 2,
+    "total": 2
+}
+```
+
+
+### 🔧 Salvar Como
+
+O Plugin *Salvar Como* pode ser chamado 

package/build/ckeditor.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @license Copyright (c) 2014-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { DecoupledEditor } from '@ckeditor/ckeditor5-editor-decoupled';
+import { Alignment } from '@ckeditor/ckeditor5-alignment';
+import { Autoformat } from '@ckeditor/ckeditor5-autoformat';
+import { Autosave } from '@ckeditor/ckeditor5-autosave';
+import { Bold, Code, Italic, Strikethrough, Subscript, Superscript, Underline } from '@ckeditor/ckeditor5-basic-styles';
+import { BlockQuote } from '@ckeditor/ckeditor5-block-quote';
+import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';
+import { CodeBlock } from '@ckeditor/ckeditor5-code-block';
+import { Essentials } from '@ckeditor/ckeditor5-essentials';
+import { FindAndReplace } from '@ckeditor/ckeditor5-find-and-replace';
+import { FontBackgroundColor, FontColor, FontFamily, FontSize } from '@ckeditor/ckeditor5-font';
+import { Heading } from '@ckeditor/ckeditor5-heading';
+import { Highlight } from '@ckeditor/ckeditor5-highlight';
+import { HorizontalLine } from '@ckeditor/ckeditor5-horizontal-line';
+import { HtmlEmbed } from '@ckeditor/ckeditor5-html-embed';
+import { DataFilter, DataSchema, GeneralHtmlSupport, HtmlComment } from '@ckeditor/ckeditor5-html-support';
+import { AutoImage, Image, ImageCaption, ImageInsert, ImageResize, ImageStyle, ImageToolbar, ImageUpload } from '@ckeditor/ckeditor5-image';
+import { Indent, IndentBlock } from '@ckeditor/ckeditor5-indent';
+import { TextPartLanguage } from '@ckeditor/ckeditor5-language';
+import { AutoLink, Link, LinkImage } from '@ckeditor/ckeditor5-link';
+import { List, ListProperties, TodoList } from '@ckeditor/ckeditor5-list';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
+import { Mention } from '@ckeditor/ckeditor5-mention';
+import { PageBreak } from '@ckeditor/ckeditor5-page-break';
+import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
+import { RemoveFormat } from '@ckeditor/ckeditor5-remove-format';
+import { StandardEditingMode } from '@ckeditor/ckeditor5-restricted-editing';
+import { SelectAll } from '@ckeditor/ckeditor5-select-all';
+import { ShowBlocks } from '@ckeditor/ckeditor5-show-blocks';
+import { SourceEditing } from '@ckeditor/ckeditor5-source-editing';
+import { SpecialCharacters, SpecialCharactersArrows, SpecialCharactersCurrency, SpecialCharactersEssentials, SpecialCharactersLatin, SpecialCharactersMathematical, SpecialCharactersText } from '@ckeditor/ckeditor5-special-characters';
+import { Style } from '@ckeditor/ckeditor5-style';
+import { Table, TableCaption, TableCellProperties, TableColumnResize, TableProperties, TableToolbar } from '@ckeditor/ckeditor5-table';
+import { TextTransformation } from '@ckeditor/ckeditor5-typing';
+import { EditorWatchdog } from '@ckeditor/ckeditor5-watchdog';
+import { WordCount } from '@ckeditor/ckeditor5-word-count';
+import ImportarSei from './plugins/sei';
+declare class Editor extends DecoupledEditor {
+    static builtinPlugins: (typeof ImportarSei | typeof Alignment | typeof AutoImage | typeof AutoLink | typeof Autoformat | typeof Autosave | typeof BlockQuote | typeof Bold | typeof CloudServices | typeof Code | typeof CodeBlock | typeof DataFilter | typeof DataSchema | typeof Essentials | typeof FindAndReplace | typeof FontBackgroundColor | typeof FontColor | typeof FontFamily | typeof FontSize | typeof GeneralHtmlSupport | typeof Heading | typeof Highlight | typeof HorizontalLine | typeof HtmlComment | typeof HtmlEmbed | typeof Image | typeof ImageCaption | typeof ImageInsert | typeof ImageResize | typeof ImageStyle | typeof ImageToolbar | typeof ImageUpload | typeof Indent | typeof IndentBlock | typeof Italic | typeof Link | typeof LinkImage | typeof List | typeof ListProperties | typeof MediaEmbed | typeof Mention | typeof PageBreak | typeof Paragraph | typeof PasteFromOffice | typeof RemoveFormat | typeof SelectAll | typeof ShowBlocks | typeof SourceEditing | typeof SpecialCharacters | typeof SpecialCharactersArrows | typeof SpecialCharactersCurrency | typeof SpecialCharactersEssentials | typeof SpecialCharactersLatin | typeof SpecialCharactersMathematical | typeof SpecialCharactersText | typeof StandardEditingMode | typeof Strikethrough | typeof Style | typeof Subscript | typeof Superscript | typeof Table | typeof TableCaption | typeof TableCellProperties | typeof TableColumnResize | typeof TableProperties | typeof TableToolbar | typeof TextPartLanguage | typeof TextTransformation | typeof TodoList | typeof Underline | typeof WordCount)[];
+    static defaultConfig: {
+        toolbar: {
+            items: string[];
+            shouldNotGroupWhenFull: boolean;
+        };
+        language: string;
+        image: {
+            toolbar: string[];
+        };
+        table: {
+            contentToolbar: string[];
+        };
+        list: {
+            properties: {
+                styles: boolean;
+                startIndex: boolean;
+                reversed: boolean;
+            };
+        };
+    };
+}
+declare const _default: {
+    Editor: typeof Editor;
+    EditorWatchdog: typeof EditorWatchdog;
+};
+export default _default;