@_sh/strapi-plugin-ckeditor 5.0.2 → 6.0.0

package/README.md

@@ -122,10 +122,25 @@ default to the Strapi admin's preferred language. If no preference is set, Engli
 
 > 💡 It is important to use the content styles on the publishing side of your application. Otherwise, the content will look different in the editor and for your end users. [Follow the documentation](https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/css.html#styling-the-published-content).
 
+> To display content from external sources, such as images or videos, in your admin panel,
+> you need to configure your `middlewares.js` file.
+> [**Check the documentation for details.**](https://docs.strapi.io/dev-docs/configurations/middlewares#security)
+
 ## <a id="configuration"></a>⚙️ Configuration
 
-The plugin configuration must be defined on the front-end. The plugin provides a `setPluginConfig`
-function, which accepts a plugin configuration (`PluginConfig`) that can include an array of presets
+The plugin configuration must be defined on the front-end.
+
+The plugin provides a set of functions that allow you to modify the plugin's configuration:
+
+```ts
+setPluginConfig(config);
+getPluginPresets();
+getPluginTheme();
+```
+
+**setPluginConfig**
+
+The function, accepts a plugin configuration (`PluginConfig`) that can include an array of presets
 and a theme object:
 
 ```ts
@@ -219,6 +234,28 @@ type Theme = {
 export type EditorStyles = string | Interpolation<object>[];
 ```
 
+**getPluginPresets**
+
+```ts
+function getPluginPresets(): {
+  [key: string]: Preset;
+};
+```
+
+Returns `presets` object.
+
+- Each property name must match the corresponding preset's name.
+- To extend or modify the options visible in the admin panel's content manager,
+  changes must be made before the admin panel's bootstrap lifecycle function.
+
+**getPluginTheme**
+
+```ts
+function getPluginTheme(): Theme;
+```
+
+Returns `theme` object.
+
 **Default presets and theme**
 
 To simplify the process of defining a new preset, the plugin exports default presets and
@@ -351,7 +388,7 @@ export type EditorStyles = string | Interpolation<object>[];
 ### Configuration examples:
 
 <details>
-  <summary>Adding a new preset [JS]</summary>
+  <summary>Setting a new set of presets [JS]</summary>
 
 ```js
 // src/admin/app.js
@@ -429,7 +466,7 @@ export default {
 </details>
 
 <details>
-  <summary>Adding a new preset [TS]</summary>
+  <summary>Setting a new set of presets [TS]</summary>
 
 ```ts
 // src/admin/app.tsx
@@ -513,7 +550,7 @@ export default {
 </details>
 
 <details>
-  <summary>Default presets modification [TS]</summary>
+  <summary>Default presets modification using setPluginConfig [TS]</summary>
 
 ```ts
 // src/admin/app.tsx
@@ -587,7 +624,67 @@ export default {
 </details>
 
 <details>
-  <summary>Modifying theme [TS]</summary>
+  <summary>Default presets modification using getPluginPresets [TS]</summary>
+
+```ts
+// src/admin/app.tsx
+
+import { css } from 'styled-components';
+import { getPluginPresets } from '@_sh/strapi-plugin-ckeditor';
+
+export default {
+  register() {
+    const presets = getPluginPresets();
+
+    presets.defaultHtml.styles = css`
+      .ck {
+        color: red;
+      }
+    `;
+
+    presets.defaultHtml.editorConfig = {
+      ...presets.defaultHtml.editorConfig,
+      placeholder: 'Modified default HTML editor',
+      toolbar: [
+        'heading',
+        '|',
+        'bold',
+        'italic',
+        'link',
+        'bulletedList',
+        'numberedList',
+        '|',
+        'strapiMediaLib',
+        'insertTable',
+        '|',
+        'undo',
+        'redo',
+      ],
+    };
+
+    presets.defaultMarkdown = {
+      ...presets.defaultMarkdown,
+      description: 'Modified default Markdown editor',
+      styles: css`
+        .ck {
+          --ck-editor-max-width: 1500px;
+          --ck-editor-min-height: 700px;
+          --ck-editor-max-height: 700px;
+        }
+
+        .ck.ck-editor__main {
+          border: 3px dashed ${({ theme }) => theme.colors.warning500};
+        }
+      `,
+    };
+  },
+};
+```
+
+</details>
+
+<details>
+  <summary>Modifying theme using setPluginConfig [TS]</summary>
 
 ```ts
 // src/admin/app.tsx
@@ -622,6 +719,36 @@ export default {
 
 </details>
 
+<details>
+  <summary>Modifying theme using getPluginTheme [TS]</summary>
+
+```ts
+// src/admin/app.tsx
+
+import { css } from 'styled-components';
+import { getPluginTheme } from '@_sh/strapi-plugin-ckeditor';
+
+export default {
+  register() {
+    const theme = getPluginTheme();
+
+    theme.additional = css`
+      .ck {
+        --ck-editor-max-width: 1500px;
+        --ck-editor-min-height: 700px;
+        --ck-editor-max-height: 700px;
+      }
+
+      .ck.ck-editor__main {
+        border: 3px dashed ${({ theme }) => theme.colors.warning500};
+      }
+    `;
+  },
+};
+```
+
+</details>
+
 <details>
   <summary>Adding Timestamp plugin [JS]</summary>
 
@@ -673,10 +800,6 @@ export default {
 
 > 📌 It is highly recommended to explore [**the official CKEditor5 documentation**](https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/configuration.html).
 
-> 💡 To display content from external sources, such as images or videos, in your admin panel,
-> you need to configure your `middlewares.js` file.
-> [**Check the documentation for details.**](https://docs.strapi.io/dev-docs/configurations/middlewares#security)
-
 ## <a id="contributing"></a>🛠 Contributing
 
 Feel free to [fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)

package/dist/_chunks/{Field-D_JHCz5O.mjs → Field-g8gLpd2N.mjs}

@@ -6,7 +6,8 @@ import { useStrapiApp, useField } from "@strapi/strapi/admin";
 import { ClassicEditor } from "ckeditor5";
 import { CKEditor } from "@ckeditor/ckeditor5-react";
 import "ckeditor5/ckeditor5.css";
-import { g as getPluginConfig, p as prefixFileUrlWithBackendUrl, i as isImageResponsive } from "./index-D3a4OadF.mjs";
+import { g as getPluginConfig, p as prefixFileUrlWithBackendUrl, i as isImageResponsive } from "./index-re_mQliQ.mjs";
+import "sanitize-html";
 import { Collapse, Expand } from "@strapi/icons";
 const STORAGE_KEYS = {
   TOKEN: "jwtToken",

package/dist/_chunks/{Field-DplOWQLX.js → Field-kyiYSdM-.js}

@@ -30,7 +30,8 @@ const admin = require("@strapi/strapi/admin");
 const ckeditor5 = require("ckeditor5");
 const ckeditor5React = require("@ckeditor/ckeditor5-react");
 require("ckeditor5/ckeditor5.css");
-const index = require("./index-CsSYDZ4y.js");
+const index = require("./index-lgM3BQrm.js");
+require("sanitize-html");
 const icons = require("@strapi/icons");
 const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
 const React__default = /* @__PURE__ */ _interopDefault(React);

package/dist/_chunks/{index-CsSYDZ4y.js → index-lgM3BQrm.js}

@@ -28,7 +28,7 @@ const yup__namespace = /* @__PURE__ */ _interopNamespace(yup);
 const sanitizeHtml__namespace = /* @__PURE__ */ _interopNamespace(sanitizeHtml);
 const cloneDeep__default = /* @__PURE__ */ _interopDefault(cloneDeep);
 const name = "@_sh/strapi-plugin-ckeditor";
-const version = "5.0.2";
+const version = "6.0.0";
 const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)";
 const keywords = [
   "strapi",
@@ -95,7 +95,7 @@ const dependencies = {
   "@ckeditor/ckeditor5-react": "~9.5.0",
   "@strapi/design-system": "2.0.0-rc.18",
   "@strapi/icons": "2.0.0-rc.18",
-  ckeditor5: "~44.3.0",
+  ckeditor5: "~45.0.0",
   lodash: "4.17.21",
   "sanitize-html": "2.13.0",
   yup: "0.32.9"
@@ -845,7 +845,7 @@ const editorConfig$1 = {
     "alignment",
     {
       label: "Indentation",
-      icon: ckeditor5.icons.indent,
+      icon: ckeditor5.IconIndent,
       items: ["outdent", "indent"]
     },
     "bulletedList",
@@ -1191,20 +1191,16 @@ function setPluginConfig(userPluginConfig) {
   if (userTheme) {
     PLUGIN_CONFIG.theme = userTheme;
   }
-  deepFreeze(PLUGIN_CONFIG);
+}
+function getPluginPresets() {
+  return PLUGIN_CONFIG.presets;
+}
+function getPluginTheme() {
+  return PLUGIN_CONFIG.presets;
 }
 function getPluginConfig() {
-  if (!Object.isFrozen(PLUGIN_CONFIG)) deepFreeze(PLUGIN_CONFIG);
   return PLUGIN_CONFIG;
 }
-function deepFreeze(obj) {
-  Object.keys(obj).forEach((p) => {
-    if (typeof obj[p] === "object" && obj[p] !== null && !Object.isFrozen(obj[p])) {
-      deepFreeze(obj[p]);
-    }
-  });
-  return Object.freeze(obj);
-}
 function CKEditorIcon() {
   return /* @__PURE__ */ jsxRuntime.jsx(IconBox, { justifyContent: "center", alignItems: "center", width: 7, height: 6, hasRadius: true, "aria-hidden": true, children: /* @__PURE__ */ jsxRuntime.jsx(SvgIcon, {}) });
 }
@@ -1269,7 +1265,7 @@ const index = {
         defaultMessage: "The advanced rich text editor. (Community Edition)"
       },
       components: {
-        Input: async () => Promise.resolve().then(() => require("./Field-DplOWQLX.js")).then((module2) => ({
+        Input: async () => Promise.resolve().then(() => require("./Field-kyiYSdM-.js")).then((module2) => ({
           default: module2.Field
         }))
       },
@@ -1343,6 +1339,8 @@ exports.clonedDefaultHtmlPreset = clonedDefaultHtmlPreset;
 exports.clonedDefaultMarkdownPreset = clonedDefaultMarkdownPreset;
 exports.clonedDefaultTheme = clonedDefaultTheme;
 exports.getPluginConfig = getPluginConfig;
+exports.getPluginPresets = getPluginPresets;
+exports.getPluginTheme = getPluginTheme;
 exports.index = index;
 exports.isImageResponsive = isImageResponsive;
 exports.prefixFileUrlWithBackendUrl = prefixFileUrlWithBackendUrl;

package/dist/_chunks/{index-D3a4OadF.mjs → index-re_mQliQ.mjs}

@@ -1,12 +1,12 @@
 import * as yup from "yup";
 import { css, styled } from "styled-components";
-import { Plugin, ButtonView, FileRepository, logWarning, Alignment, Autoformat, AutoImage, BalloonToolbar, BlockQuote, Bold, Code, CodeBlock, Essentials, FontBackgroundColor, FontColor, FontFamily, FontSize, GeneralHtmlSupport, Heading, HorizontalLine, HtmlEmbed, Image, ImageCaption, ImageInsert, ImageResize, ImageStyle, ImageToolbar, ImageUpload, Indent, IndentBlock, Italic, List, ListProperties, Link, LinkImage, MediaEmbed, Paragraph, PageBreak, PasteFromOffice, PictureEditing, RemoveFormat, SourceEditing, SpecialCharacters, SpecialCharactersEssentials, Strikethrough, Style, Subscript, Superscript, ShowBlocks, Table, TableCaption, TableCellProperties, TableColumnResize, TableProperties, TableToolbar, TodoList, Underline, WordCount, icons, Markdown, TextTransformation } from "ckeditor5";
+import { Plugin, ButtonView, FileRepository, logWarning, Alignment, Autoformat, AutoImage, BalloonToolbar, BlockQuote, Bold, Code, CodeBlock, Essentials, FontBackgroundColor, FontColor, FontFamily, FontSize, GeneralHtmlSupport, Heading, HorizontalLine, HtmlEmbed, Image, ImageCaption, ImageInsert, ImageResize, ImageStyle, ImageToolbar, ImageUpload, Indent, IndentBlock, Italic, List, ListProperties, Link, LinkImage, MediaEmbed, Paragraph, PageBreak, PasteFromOffice, PictureEditing, RemoveFormat, SourceEditing, SpecialCharacters, SpecialCharactersEssentials, Strikethrough, Style, Subscript, Superscript, ShowBlocks, Table, TableCaption, TableCellProperties, TableColumnResize, TableProperties, TableToolbar, TodoList, Underline, WordCount, IconIndent, Markdown, TextTransformation } from "ckeditor5";
 import * as sanitizeHtml from "sanitize-html";
 import { jsx, jsxs } from "react/jsx-runtime";
 import { Flex, lightTheme } from "@strapi/design-system";
 import cloneDeep from "lodash/cloneDeep";
 const name = "@_sh/strapi-plugin-ckeditor";
-const version = "5.0.2";
+const version = "6.0.0";
 const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)";
 const keywords = [
   "strapi",
@@ -73,7 +73,7 @@ const dependencies = {
   "@ckeditor/ckeditor5-react": "~9.5.0",
   "@strapi/design-system": "2.0.0-rc.18",
   "@strapi/icons": "2.0.0-rc.18",
-  ckeditor5: "~44.3.0",
+  ckeditor5: "~45.0.0",
   lodash: "4.17.21",
   "sanitize-html": "2.13.0",
   yup: "0.32.9"
@@ -823,7 +823,7 @@ const editorConfig$1 = {
     "alignment",
     {
       label: "Indentation",
-      icon: icons.indent,
+      icon: IconIndent,
       items: ["outdent", "indent"]
     },
     "bulletedList",
@@ -1169,20 +1169,16 @@ function setPluginConfig(userPluginConfig) {
   if (userTheme) {
     PLUGIN_CONFIG.theme = userTheme;
   }
-  deepFreeze(PLUGIN_CONFIG);
+}
+function getPluginPresets() {
+  return PLUGIN_CONFIG.presets;
+}
+function getPluginTheme() {
+  return PLUGIN_CONFIG.presets;
 }
 function getPluginConfig() {
-  if (!Object.isFrozen(PLUGIN_CONFIG)) deepFreeze(PLUGIN_CONFIG);
   return PLUGIN_CONFIG;
 }
-function deepFreeze(obj) {
-  Object.keys(obj).forEach((p) => {
-    if (typeof obj[p] === "object" && obj[p] !== null && !Object.isFrozen(obj[p])) {
-      deepFreeze(obj[p]);
-    }
-  });
-  return Object.freeze(obj);
-}
 function CKEditorIcon() {
   return /* @__PURE__ */ jsx(IconBox, { justifyContent: "center", alignItems: "center", width: 7, height: 6, hasRadius: true, "aria-hidden": true, children: /* @__PURE__ */ jsx(SvgIcon, {}) });
 }
@@ -1247,7 +1243,7 @@ const index = {
         defaultMessage: "The advanced rich text editor. (Community Edition)"
       },
       components: {
-        Input: async () => import("./Field-D_JHCz5O.mjs").then((module) => ({
+        Input: async () => import("./Field-g8gLpd2N.mjs").then((module) => ({
           default: module.Field
         }))
       },
@@ -1321,8 +1317,10 @@ export {
   clonedDefaultHtmlPreset as b,
   clonedDefaultTheme as c,
   clonedDefaultMarkdownPreset as d,
-  StrapiUploadAdapter as e,
+  getPluginPresets as e,
+  getPluginTheme as f,
   getPluginConfig as g,
+  StrapiUploadAdapter as h,
   isImageResponsive as i,
   prefixFileUrlWithBackendUrl as p,
   setPluginConfig as s

package/dist/admin/index.js

@@ -1,12 +1,15 @@
 "use strict";
 Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
 require("yup");
-const index = require("../_chunks/index-CsSYDZ4y.js");
+const index = require("../_chunks/index-lgM3BQrm.js");
 require("ckeditor5");
+require("sanitize-html");
 exports.StrapiMediaLib = index.StrapiMediaLib;
 exports.StrapiUploadAdapter = index.StrapiUploadAdapter;
 exports.default = index.index;
 exports.defaultHtmlPreset = index.clonedDefaultHtmlPreset;
 exports.defaultMarkdownPreset = index.clonedDefaultMarkdownPreset;
 exports.defaultTheme = index.clonedDefaultTheme;
+exports.getPluginPresets = index.getPluginPresets;
+exports.getPluginTheme = index.getPluginTheme;
 exports.setPluginConfig = index.setPluginConfig;

package/dist/admin/index.mjs

@@ -1,12 +1,15 @@
 import "yup";
-import { S, e, a, b, d, c, s } from "../_chunks/index-D3a4OadF.mjs";
+import { S, h, a, b, d, c, e, f, s } from "../_chunks/index-re_mQliQ.mjs";
 import "ckeditor5";
+import "sanitize-html";
 export {
   S as StrapiMediaLib,
-  e as StrapiUploadAdapter,
+  h as StrapiUploadAdapter,
   a as default,
   b as defaultHtmlPreset,
   d as defaultMarkdownPreset,
   c as defaultTheme,
+  e as getPluginPresets,
+  f as getPluginTheme,
   s as setPluginConfig
 };

package/dist/admin/src/config/pluginConfig.d.ts

@@ -1,22 +1,36 @@
-import type { PluginConfig, UserPluginConfig } from './types';
+import type { PluginConfig, UserPluginConfig, Preset, Theme } from './types';
 /**
  * Sets a configuration for the plugin.
  *
  * @remarks
  *
- * - The function must be invoked before the admin panel's bootstrap lifecycle function.
- * The general recommendation is to call it inside the admin panel's register lifecycle function.
+ * - Function must be invoked before the admin panel's bootstrap lifecycle function.
+ * The recommended way is to invoke it within the admin panel's register lifecycle function.
  *
  * - Provided properties will overwrite the default configuration values.
  *
- * - The configuration becomes immutable after the first invocation, preventing further
- * modifications.
- *
- * @param userConfig - The plugin configuration object.
+ * @param userConfig - Plugin configuration object.
  */
 export declare function setPluginConfig(userPluginConfig: UserPluginConfig): void;
 /**
- * Retrieves the current plugin configuration, ensuring it is immutable.
+ * Returns the presets object.
+ *
+ * @remarks
+ *
+ * - Each property name must match the corresponding preset's name.
+ *
+ * - To extend or modify the options visible in the admin panel's content manager,
+ *   changes must be made before the admin panel's bootstrap lifecycle function.
+ *
+ */
+export declare function getPluginPresets(): Record<string, Preset>;
+/**
+ * Returns the theme object.
+ *
+ */
+export declare function getPluginTheme(): Theme;
+/**
+ * Retrieves current plugin configuration.
  *
  * @internal
  */

package/dist/admin/src/config/types.d.ts

@@ -120,4 +120,5 @@ export type Preset = {
  *
  * @see {@link https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/configuration.html | CKEditor documentation}
  */
-export type EditorConfig = CKE5EditorConfig;
+export interface EditorConfig extends CKE5EditorConfig {
+}

package/dist/admin/src/exports.d.ts

@@ -5,5 +5,5 @@ export { clonedDefaultTheme as defaultTheme };
 export { clonedDefaultHtmlPreset as defaultHtmlPreset };
 export { clonedDefaultMarkdownPreset as defaultMarkdownPreset };
 export type { UserPluginConfig as PluginConfig, EditorConfig, Preset, Theme, EditorStyles, } from './config/types';
-export { setPluginConfig } from './config';
+export { setPluginConfig, getPluginPresets, getPluginTheme } from './config';
 export { StrapiMediaLib, StrapiUploadAdapter } from './plugins';

package/dist/server/index.js

@@ -1,6 +1,6 @@
 "use strict";
 const name = "@_sh/strapi-plugin-ckeditor";
-const version = "5.0.2";
+const version = "6.0.0";
 const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)";
 const keywords = [
   "strapi",
@@ -67,7 +67,7 @@ const dependencies = {
   "@ckeditor/ckeditor5-react": "~9.5.0",
   "@strapi/design-system": "2.0.0-rc.18",
   "@strapi/icons": "2.0.0-rc.18",
-  ckeditor5: "~44.3.0",
+  ckeditor5: "~45.0.0",
   lodash: "4.17.21",
   "sanitize-html": "2.13.0",
   yup: "0.32.9"

package/dist/server/index.mjs

@@ -1,5 +1,5 @@
 const name = "@_sh/strapi-plugin-ckeditor";
-const version = "5.0.2";
+const version = "6.0.0";
 const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)";
 const keywords = [
   "strapi",
@@ -66,7 +66,7 @@ const dependencies = {
   "@ckeditor/ckeditor5-react": "~9.5.0",
   "@strapi/design-system": "2.0.0-rc.18",
   "@strapi/icons": "2.0.0-rc.18",
-  ckeditor5: "~44.3.0",
+  ckeditor5: "~45.0.0",
   lodash: "4.17.21",
   "sanitize-html": "2.13.0",
   yup: "0.32.9"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_sh/strapi-plugin-ckeditor",
-  "version": "5.0.2",
+  "version": "6.0.0",
   "description": "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)",
   "keywords": [
     "strapi",
@@ -67,7 +67,7 @@
     "@ckeditor/ckeditor5-react": "~9.5.0",
     "@strapi/design-system": "2.0.0-rc.18",
     "@strapi/icons": "2.0.0-rc.18",
-    "ckeditor5": "~44.3.0",
+    "ckeditor5": "~45.0.0",
     "lodash": "4.17.21",
     "sanitize-html": "2.13.0",
     "yup": "0.32.9"