@ckeditor/ckeditor5-export-pdf 44.1.0 → 44.2.0-alpha.0

package/dist/exportpdf.d.ts

@@ -1,242 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module export-pdf/exportpdf
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { Notification } from 'ckeditor5/src/ui.js';
-import type { InitializedToken, TokenUrl } from '@ckeditor/ckeditor5-cloud-services';
-import ExportPdfUI from './exportpdfui.js';
-/**
- * The export to PDF feature.
- *
- * It allows you to generate a PDF file directly from the editor content.
- *
- * For a detailed overview, check the {@glink features/converters/export-pdf export to PDF} feature documentation.
- */
-export default class ExportPdf extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ExportPdf";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["CloudServices", typeof Notification, typeof ExportPdfUI];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
-/**
- * The configuration of the export to PDF feature. It is used by the PDF export features from the `@ckeditor/ckeditor5-export-pdf` package.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		exportPdf: ... // Export to PDF feature options.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface ExportPdfConfig {
-    /**
-     * Paths to the `.css` files containing additional styling for the editor's content (**the order of provided items matters**).
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	stylesheets: [ './path/to/custom-style.css' ]
-     * }
-     * ```
-     *
-     * **NOTE:** If `stylesheets` are not provided, the plugin will sent only
-     * {@glink getting-started/setup/css the default editor content styles}
-     * to the converter.
-     *
-     * **Default editor's content styles**:
-     * {@glink getting-started/setup/css The default editor content styles}
-     * are applied to the generated PDF thanks to the `'EDITOR_STYLES'` token, which is provided to the `stylesheets` by default.
-     * If you don't want them to be applied, you have to omit the token:
-     *
-     * **NOTE:** The `'EDITOR_STYLES'` string is only supported in legacy custom builds with webpack or DLLs.
-     * In other setups you always need to pass the stylesheets.
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	stylesheets: [ './path/to/custom-editor-styles.css' ]
-     * }
-     * ```
-     *
-     * **Web fonts:** If you want to {@glink features/converters/export-pdf#providing-web-font-styles use web fonts} in your PDF document,
-     * you should provide a path to the file containing the web font declaration before the `'EDITOR_STYLES'` token and other style sheets:
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	stylesheets: [
-     * 		'./path/to/fonts.css'
-     * 		'./path/to/editor-styles.css',
-     * 	]
-     * }
-     * ```
-     *
-     * **Web fonts and custom styling:** For more advanced styling, your configuration should look like this:
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	stylesheets: [
-     * 		'./path/to/fonts.css',
-     * 		'./path/to/editor-styles.css',
-     * 		'./path/to/custom-styles.css'
-     * 	]
-     * }
-     * ```
-     *
-     * @default `[ 'EDITOR_STYLES' ]`
-     */
-    stylesheets?: Array<string>;
-    /**
-     * The name of the generated PDF file.
-     *
-     * ```ts
-     * // Static file name.
-     * const exportPdfConfig = {
-     * 	fileName: 'my-document.pdf'
-     * }
-     *
-     * // Dynamic file name.
-     * const exportPdfConfig = {
-     * 	fileName: () => {
-     * 		const articleTitle = document.querySelector( '#title' );
-     *
-     * 		return `${ articleTitle.value }.pdf`;
-     * 	}
-     * }
-     * ```
-     *
-     * **NOTE:** The file name must contain the `.pdf` extension.
-     * Otherwise your operating system or device may have trouble identifying the file type.
-     *
-     * @default 'document.pdf'
-     */
-    fileName?: string | (() => string);
-    /**
-     * A URL to the HTML to PDF converter.
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	converterUrl: 'https://myconverter.com/v1/'
-     * }
-     * ```
-     *
-     * **NOTE:** The plugin uses the default HTML to PDF converter delivered by CKEditor Cloud Services.
-     * You can provide a URL to an on-premises converter instead.
-     *
-     * @default 'https://pdf-converter.cke-cs.com/v1/convert'
-     */
-    converterUrl?: string;
-    /**
-     * The HTML to PDF converter options.
-     *
-     * **NOTE:** Configuring the plugin is not mandatory but it is highly recommended,
-     * especially if you want to get the most accurate results when generating the PDF file.
-     * To learn more, please check the [HTML to PDF converter configuration](https://pdf-converter.cke-cs.com/docs).
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	converterOptions: {
-     * 		...
-     * 	}
-     * }
-     * ```
-     *
-     * @default `{
-     * 	format: 'A4',
-     * 	margin_top: '0',
-     * 	margin_bottom: '0',
-     * 	margin_right: '0',
-     * 	margin_left: '0',
-     * 	page_orientation: 'portrait',
-     * 	header_html: undefined,
-     * 	footer_html: undefined,
-     * 	header_and_footer_css: undefined,
-     * 	wait_for_network: true,
-     * 	wait_time: 0
-     * }`
-     */
-    converterOptions?: ExportPdfConverterOptions;
-    /**
-     * A function to gather the HTML to be converted to PDF.
-     *
-     * **NOTE:** This option may be useful when the editor does not have `getData()` method,
-     * or if the HTML to be converted should be different than the edited one.
-     *
-     * ```ts
-     * const exportPdfConfig = {
-     * 	dataCallback: ( editor: Editor ) => {
-     * 		return `
-     * 			<header id="header">${ editor.data.get( { rootName: 'header' } ) }</header>
-     * 			<div id="content">${ editor.data.get( { rootName: 'content' } ) }</div>
-     * 		`;
-     * 	}
-     * }
-     * ```
-     *
-     * @default `( editor: Editor ) => editor.getData()`
-     */
-    dataCallback?: (editor: Editor) => string;
-    /**
-     * A token URL or a token request function. This field is optional and should be used only when a different `tokenUrl` is required for
-     * the export to PDF feature.
-     *
-     * **Note:** The token can be disabled with the `false` value provided.
-     *
-     * See: {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl}
-     */
-    tokenUrl?: TokenUrl | false;
-    /**
-     * The authentication token.
-     *
-     * See: {@link module:cloud-services/cloudservices~CloudServices#token}
-     */
-    token?: InitializedToken;
-    /**
-     * The application unique identifier.
-     */
-    appID?: string;
-}
-export type ExportPdfConverterOptions = {
-    format?: 'Letter' | 'Legal' | 'Tabloid' | 'Ledger' | 'A0' | 'A1' | 'A2' | 'A3' | 'A4' | 'A5' | 'A6' | string & Record<never, never>;
-    margin_top?: string;
-    margin_bottom?: string;
-    margin_right?: string;
-    margin_left?: string;
-    header_html?: string;
-    footer_html?: string;
-    header_and_footer_css?: string;
-    page_orientation?: 'portrait' | 'landscape' | string & Record<never, never>;
-    wait_for_network?: boolean;
-    wait_time?: number;
-    merge_fields?: {
-        prefix: string;
-        suffix: string;
-        data: Record<string, string>;
-    };
-};

package/dist/exportpdfcommand.d.ts

@@ -1,43 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module export-pdf/exportpdfcommand
- * @publicApi
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-import { type ExportPdfConfig } from './exportpdf.js';
-/**
- * The export to PDF command.
- *
- * It takes the editor's HTML and CSS rules from the document and sends them to the HTML to PDF converter.
- * After processing, the converter will send back a PDF file for download.
- */
-export default class ExportPdfCommand extends Command {
-    /**
-     * A command state that indicates if the command is currently executing.
-     *
-     * @observable
-     */
-    isBusy: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Options for the executed command.
-     */
-    execute(options?: ExportPdfConfig): Promise<void>;
-}

package/dist/exportpdfui.d.ts

@@ -1,35 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module export-pdf/exportpdfui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The export to PDF UI feature.
- *
- * It introduces 'Export to PDF' button in toolbar and menu bar.
- */
-export default class ExportPdfUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ExportPdfUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/index.d.ts

@@ -1,14 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module export-pdf
- */
-export { default as ExportPdf, type ExportPdfConfig } from './exportpdf.js';
-export type { default as ExportPdfCommand } from './exportpdfcommand.js';
-import './augmentation.js';

package/dist/utils/common-translations.d.ts

@@ -1,13 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module export-pdf/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string): string;

package/dist/utils.d.ts

@@ -1,14 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * A helper function for getting concatenated CSS rules from external stylesheets and the editor.
- *
- * @param stylesheets An array of stylesheet paths delivered by the user through the plugin configuration.
- */
-export declare function getStyles(stylesheets?: Array<string>): Promise<string>;

package/src/utils.d.ts

@@ -1,10 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * A helper function for getting concatenated CSS rules from external stylesheets and the editor.
- *
- * @param stylesheets An array of stylesheet paths delivered by the user through the plugin configuration.
- */
-export declare function getStyles(stylesheets?: Array<string>): Promise<string>;

package/src/utils.js

@@ -1,23 +0,0 @@
-/*
- *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- *
- *
- *
- *
- *          +---------------------------------------------------------------------------------+
- *          |                                                                                 |
- *          |                                 Hello stranger!                                 |
- *          |                                                                                 |
- *          |                                                                                 |
- *          |   What you're currently looking at is the source code of a legally protected,   |
- *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
- *          |               are forbidden and will result in legal consequences.              |
- *          |                                                                                 |
- *          |                                                                                 |
- *          +---------------------------------------------------------------------------------+
- *
- *
- *
- *
- */
-(function(_0x103e2a,_0x23ddb7){const _0x2e85c8=_0xe62f,_0x24b83e=_0x103e2a();while(!![]){try{const _0x54b640=parseInt(_0x2e85c8(0x1d1))/0x1*(parseInt(_0x2e85c8(0x1c9))/0x2)+-parseInt(_0x2e85c8(0x1cf))/0x3*(-parseInt(_0x2e85c8(0x1d2))/0x4)+parseInt(_0x2e85c8(0x1c1))/0x5+-parseInt(_0x2e85c8(0x1c4))/0x6*(parseInt(_0x2e85c8(0x1b7))/0x7)+-parseInt(_0x2e85c8(0x1bb))/0x8+-parseInt(_0x2e85c8(0x1c5))/0x9*(-parseInt(_0x2e85c8(0x1be))/0xa)+-parseInt(_0x2e85c8(0x1c2))/0xb;if(_0x54b640===_0x23ddb7)break;else _0x24b83e['push'](_0x24b83e['shift']());}catch(_0x2a97ac){_0x24b83e['push'](_0x24b83e['shift']());}}}(_0x3e51,0x565b1));function _0xe62f(_0x1b74ca,_0x3c1634){const _0x3e516d=_0x3e51();return _0xe62f=function(_0xe62f6f,_0x227be1){_0xe62f6f=_0xe62f6f-0x1b7;let _0x53017e=_0x3e516d[_0xe62f6f];return _0x53017e;},_0xe62f(_0x1b74ca,_0x3c1634);}export function getStyles(_0x14a07f){const _0x167253=_0xe62f;if(!_0x14a07f)return new Promise(_0x5dbe3c=>_0x5dbe3c(''));const _0x1b3e44=[];for(const _0x358756 of _0x14a07f)_0x167253(0x1ba)!==_0x358756?_0x1b3e44[_0x167253(0x1bc)](window[_0x167253(0x1d0)](_0x358756)[_0x167253(0x1cc)](_0xc87098=>_0xc87098[_0x167253(0x1bd)]())):_0x1b3e44[_0x167253(0x1bc)](a());return Promise[_0x167253(0x1ca)](_0x1b3e44)[_0x167253(0x1cc)](_0xb76b9f=>_0xb76b9f[_0x167253(0x1bf)]('\x20')[_0x167253(0x1c8)]());}function _0x3e51(){const _0x12da06=['indexOf','556475GxMORs','892837uQXYIP','cssText','116826FUgZoV','270999ZsbpAG','from','.ck-content','trim','541238sUNwJe','all','The\x20editor\x20stylesheet\x20could\x20not\x20be\x20found\x20in\x20the\x20document.\x20Check\x20your\x20webpack\x20config\x20–\x20style-loader\x20should\x20use\x20data-cke=true\x20attribute\x20for\x20the\x20editor\x20stylesheet.','then','ownerNode','hasAttribute','111CeBrgj','fetch','1iITlJG','57356UsIbwi',':root','cssRules','data-cke','styleSheets','63JXAEHP','length','warn','EDITOR_STYLES','2659592vFPSwf','push','text','10sgBooQ','join'];_0x3e51=function(){return _0x12da06;};return _0x3e51();}function a(){const _0xd3df74=_0xe62f,_0x5670ff=[],_0x8f35d0=[];for(const _0x4b835e of Array[_0xd3df74(0x1c6)](document[_0xd3df74(0x1d6)])){if(_0x4b835e[_0xd3df74(0x1cd)][_0xd3df74(0x1ce)](_0xd3df74(0x1d5))){for(const _0x4aef92 of Array[_0xd3df74(0x1c6)](_0x4b835e[_0xd3df74(0x1d4)]))-0x1!==_0x4aef92[_0xd3df74(0x1c3)][_0xd3df74(0x1c0)](_0xd3df74(0x1c7))?_0x5670ff[_0xd3df74(0x1bc)](_0x4aef92[_0xd3df74(0x1c3)]):-0x1!==_0x4aef92[_0xd3df74(0x1c3)][_0xd3df74(0x1c0)](_0xd3df74(0x1d3))&&_0x8f35d0[_0xd3df74(0x1bc)](_0x4aef92[_0xd3df74(0x1c3)]);}}return _0x5670ff[_0xd3df74(0x1b8)]||console[_0xd3df74(0x1b9)](_0xd3df74(0x1cb)),[..._0x8f35d0,..._0x5670ff][_0xd3df74(0x1bf)]('\x20')[_0xd3df74(0x1c8)]();}