@_sh/strapi-plugin-ckeditor 4.0.11 → 5.0.0

package/dist/admin/index.js

@@ -1,5 +1,12 @@
 "use strict";
-require("react");
-const index = require("../_chunks/index-uYy-Myyv.js");
-module.exports = index.index;
-//# sourceMappingURL=index.js.map
+Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
+require("yup");
+const index = require("../_chunks/index-DO2vqIdx.js");
+require("ckeditor5");
+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.setPluginConfig = index.setPluginConfig;

package/dist/admin/index.mjs

@@ -1,6 +1,12 @@
-import "react";
-import { i } from "../_chunks/index-BZZiYjTp.mjs";
+import "yup";
+import { S, e, a, b, d, c, s } from "../_chunks/index-CNalXcwy.mjs";
+import "ckeditor5";
 export {
-  i as default
+  S as StrapiMediaLib,
+  e as StrapiUploadAdapter,
+  a as default,
+  b as defaultHtmlPreset,
+  d as defaultMarkdownPreset,
+  c as defaultTheme,
+  s as setPluginConfig
 };
-//# sourceMappingURL=index.mjs.map

package/dist/admin/src/components/CKEReact.d.ts

@@ -0,0 +1,6 @@
+import 'ckeditor5/ckeditor5.css';
+export type WordCountPluginStats = {
+    words: number;
+    characters: number;
+};
+export declare function CKEReact(): import("react/jsx-runtime").JSX.Element | null;

package/dist/admin/src/components/CKEditorIcon.d.ts

@@ -0,0 +1 @@
+export declare function CKEditorIcon(): import("react/jsx-runtime").JSX.Element;

package/dist/admin/src/components/Editor.d.ts

@@ -0,0 +1 @@
+export declare function Editor(): import("react/jsx-runtime").JSX.Element;

package/dist/admin/src/components/EditorLayout.d.ts

@@ -0,0 +1,4 @@
+import { type ReactNode } from 'react';
+export declare function EditorLayout({ children }: {
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/admin/src/components/EditorProvider.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import type { InputProps } from '@strapi/strapi/admin';
+import { type Preset } from '../config';
+type EditorProviderBaseProps = Pick<InputProps, 'name' | 'disabled' | 'placeholder' | 'hint' | 'label' | 'required'> & {
+    labelAction?: React.ReactNode;
+    presetName: string;
+    wordsLimit?: number;
+    charsLimit?: number;
+    isFieldLocalized: boolean;
+    error?: string;
+};
+type EditorContextValue = EditorProviderBaseProps & {
+    preset: Preset | null;
+};
+type EditorProviderProps = EditorProviderBaseProps & {
+    children: React.ReactElement;
+};
+export declare function useEditorContext(): EditorContextValue;
+export declare function EditorProvider({ name, disabled, error, placeholder, hint, label, labelAction, required, presetName, wordsLimit, charsLimit, children, isFieldLocalized, }: EditorProviderProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/admin/src/components/Field.d.ts

@@ -0,0 +1,20 @@
+import React from 'react';
+import type { InputProps, FieldValue } from '@strapi/strapi/admin';
+type CKEditorFieldProps = Readonly<InputProps & FieldValue & {
+    labelAction?: React.ReactNode;
+    attribute: {
+        options: {
+            preset: string;
+            maxLengthWords: number;
+            maxLengthCharacters: number;
+        };
+        pluginOptions?: {
+            i18n?: {
+                localized?: boolean;
+            };
+        };
+    };
+}>;
+declare function Field({ name, hint, error, placeholder, label, attribute, labelAction, disabled, required, }: CKEditorFieldProps): import("react/jsx-runtime").JSX.Element;
+declare const MemoizedField: React.MemoExoticComponent<typeof Field>;
+export { MemoizedField as Field };

package/dist/admin/src/components/GlobalStyling.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+declare function GlobalStyling(): import("react/jsx-runtime").JSX.Element;
+declare const MemoizedGlobalStyling: React.MemoExoticComponent<typeof GlobalStyling>;
+export { MemoizedGlobalStyling as GlobalStyling };

package/dist/admin/src/components/MediaLib.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+type MediaLibProps = {
+    isOpen: boolean;
+    toggle: () => void;
+    handleChangeAssets: (newElems: string) => void;
+};
+declare function MediaLib({ isOpen, toggle, handleChangeAssets }: MediaLibProps): import("react/jsx-runtime").JSX.Element | null;
+declare const MemoizedMediaLib: React.MemoExoticComponent<typeof MediaLib>;
+export { MemoizedMediaLib as MediaLib };

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

@@ -0,0 +1,2 @@
+import type { Preset } from './types';
+export declare const defaultHtmlPreset: Preset;

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

@@ -0,0 +1,5 @@
+export * from './types';
+export * from './language';
+export * from './pluginConfig';
+export * from './htmlPreset';
+export * from './markdownPreset';

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

@@ -0,0 +1,15 @@
+import type { EditorConfig } from './types';
+/**
+ * Sets the language property for the provided editor configuration and loads translations.
+ *
+ * @internal
+ *
+ * @remarks
+ *
+ * - UI language: If the language is not set, it defaults to the admin's preferred language, falling
+ * back to 'en'. If the language is other than 'en', the CKEditor translation will be loaded.
+ *
+ * - Content language: Checks whether the field is localized (`isFieldLocalized`) and applies
+ * the determined i18n language accordingly.
+ */
+export declare function setUpLanguage(config: EditorConfig, isFieldLocalized: boolean): Promise<void>;

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

@@ -0,0 +1,2 @@
+import type { Preset } from './types';
+export declare const defaultMarkdownPreset: Preset;

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

@@ -0,0 +1,23 @@
+import type { PluginConfig, UserPluginConfig } 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.
+ *
+ * - 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.
+ */
+export declare function setPluginConfig(userPluginConfig: UserPluginConfig): void;
+/**
+ * Retrieves the current plugin configuration, ensuring it is immutable.
+ *
+ * @internal
+ */
+export declare function getPluginConfig(): PluginConfig;

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

@@ -0,0 +1,123 @@
+import type { EditorConfig as CKE5EditorConfig } from 'ckeditor5';
+import type { Interpolation } from 'styled-components';
+/**
+ * Plugin configuration object.
+ *
+ * @internal
+ */
+export type PluginConfig = {
+    presets: Record<string, Preset>;
+    theme: Theme;
+};
+/**
+ * Used to register a preset option in the admin panel.
+ *
+ * @internal
+ *
+ * @see {@link https://docs.strapi.io/dev-docs/custom-fields#options | Strapi documentation}
+ */
+export type Option = {
+    metadatas: Metadatas;
+    key: string | number;
+    /**
+     * @remarks
+     *
+     * The value must match the corresponding key in the presets.
+     */
+    value: string | number;
+};
+/**
+ * Used to register a preset option in the admin panel.
+ *
+ * @internal
+ *
+ * @see {@link https://docs.strapi.io/dev-docs/custom-fields#options | Strapi documentation}
+ */
+export type Metadatas = {
+    intlLabel: IntlLabel;
+};
+/**
+ * Used to register a preset option in the admin panel.
+ *
+ * @internal
+ *
+ * @see {@link https://docs.strapi.io/dev-docs/custom-fields#options | Strapi documentation}
+ */
+export type IntlLabel = {
+    id: string;
+    defaultMessage: string;
+    values?: object;
+};
+/**
+ * Plugin configuration object.
+ */
+export type UserPluginConfig = {
+    /**
+     * Presets are sets of settings that define the editor's features and appearance.
+     */
+    presets?: Preset[];
+    /**
+     * Styles applied globally to every editor instance.
+     */
+    theme?: Theme;
+};
+/**
+ * Styles applied globally to every editor instance.
+ *
+ * @remarks
+ *
+ * The `common` styles are applied first, followed by `light` or `dark` styles
+ * according to the preferences, and finally `additional` styles.
+ */
+export type Theme = {
+    /**
+     * Core styles.
+     */
+    common?: EditorStyles;
+    /**
+     * Styles apllied in light mode.
+     */
+    light?: EditorStyles;
+    /**
+     * Styles apllied in dark mode.
+     */
+    dark?: EditorStyles;
+    /**
+     * Additional styles that complement the theme.
+     */
+    additional?: EditorStyles;
+};
+/**
+ * Represents styles that can be applied to an editor instance.
+ * Can be a plain CSS string or an array of interpolations for dynamic styling.
+ */
+export type EditorStyles = string | Interpolation<object>[];
+/**
+ * Preset is a set of settings that define the editor's features and appearance.
+ */
+export type Preset = {
+    /**
+     * Preset name, displayed in the schema.
+     */
+    name: string;
+    /**
+     * Preset description, displayed in the Content-Type Builder.
+     */
+    description: string;
+    /**
+     * Additional styles applied to the editor instance after the theme styles.
+     */
+    styles?: EditorStyles;
+    /**
+     * CKEditor configuration object.
+     *
+     * @see {@link https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/configuration.html | CKEditor documentation}
+     */
+    editorConfig: EditorConfig;
+};
+/**
+ * CKEditor configuration object.
+ *
+ * @see {@link https://ckeditor.com/docs/ckeditor5/latest/getting-started/setup/configuration.html | CKEditor documentation}
+ */
+export type EditorConfig = CKE5EditorConfig;

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

@@ -0,0 +1,9 @@
+declare const clonedDefaultTheme: import("./config").Theme;
+declare const clonedDefaultHtmlPreset: import("./config").Preset;
+declare const clonedDefaultMarkdownPreset: import("./config").Preset;
+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 { StrapiMediaLib, StrapiUploadAdapter } from './plugins';

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

@@ -0,0 +1,6 @@
+export * from './exports';
+declare const _default: {
+    bootstrap(): void;
+    register(app: any): Promise<void>;
+};
+export default _default;

package/dist/admin/src/plugins/StrapiMediaLib.d.ts

@@ -0,0 +1,15 @@
+import { Plugin } from 'ckeditor5';
+export interface StrapiMediaLibPlugin extends Plugin {
+    connect: (strapiToggle: () => void) => void;
+}
+export declare class StrapiMediaLib extends Plugin implements StrapiMediaLibPlugin {
+    /**
+     * Strapi function used to show media library modal.
+     * Should be provided via connect method before using toggle method.
+     */
+    private strapiToggle;
+    static get pluginName(): "StrapiMediaLib";
+    init(): void;
+    connect(strapiToggle: () => void): void;
+    toggle(): void;
+}

package/dist/admin/src/plugins/StrapiUploadAdapter.d.ts

@@ -0,0 +1,12 @@
+import { Plugin, FileRepository, type SimpleUploadConfig } from 'ckeditor5';
+export interface StrapiUploadAdapterConfig extends SimpleUploadConfig {
+}
+export interface StrapiUploadAdapterPlugin extends Plugin {
+    initAdapter: (config: StrapiUploadAdapterConfig) => void;
+}
+export declare class StrapiUploadAdapter extends Plugin implements StrapiUploadAdapterPlugin {
+    static get requires(): readonly [typeof FileRepository];
+    static get pluginName(): "StrapiUploadAdapter";
+    init(): void;
+    initAdapter(config: StrapiUploadAdapterConfig): void;
+}

package/dist/admin/src/plugins/index.d.ts

@@ -0,0 +1,2 @@
+export * from './StrapiMediaLib';
+export * from './StrapiUploadAdapter';

package/dist/admin/src/theme/additional.d.ts

@@ -0,0 +1 @@
+export declare const additional: import("styled-components").RuleSet<object>;

package/dist/admin/src/theme/colors.d.ts

@@ -0,0 +1 @@
+export declare const colors: import("styled-components").RuleSet<object>;

package/dist/admin/src/theme/common.d.ts

@@ -0,0 +1 @@
+export declare const common: import("styled-components").RuleSet<object>;

package/dist/admin/src/theme/dark.d.ts

@@ -0,0 +1 @@
+export declare const dark: import("styled-components").RuleSet<object>;

package/dist/admin/src/theme/index.d.ts

@@ -0,0 +1,2 @@
+import type { Theme } from '../config';
+export declare const defaultTheme: Theme;

package/dist/admin/src/theme/light.d.ts

@@ -0,0 +1 @@
+export declare const light: import("styled-components").RuleSet<object>;

package/dist/admin/src/utils/index.d.ts

@@ -0,0 +1,4 @@
+export * from './pluginId';
+export * from './localStorage';
+export * from './isImageResponsive';
+export * from './prefixWithBackendUrl';

package/dist/admin/src/utils/isImageResponsive.d.ts

@@ -0,0 +1,3 @@
+export declare function isImageResponsive(imgFormats: {
+    [k: string]: Object;
+}): boolean;

package/dist/admin/src/utils/localStorage.d.ts

@@ -0,0 +1,3 @@
+export declare function getStoredToken(): string | null;
+export declare function getPreferedLanguage(): string | 'en';
+export declare function getProfileTheme(): 'light' | 'dark' | 'system' | null;

package/dist/admin/src/utils/pluginId.d.ts

@@ -0,0 +1 @@
+export declare const PLUGIN_ID: string;

package/dist/admin/src/utils/prefixWithBackendUrl.d.ts

@@ -0,0 +1 @@
+export declare function prefixFileUrlWithBackendUrl(fileURL: string): string;

package/dist/server/index.js

@@ -1,13 +1,7 @@
 "use strict";
-const require$$0$1 = require("fs");
-const _interopDefault = (e) => e && e.__esModule ? e : { default: e };
-const require$$0__default = /* @__PURE__ */ _interopDefault(require$$0$1);
-function getDefaultExportFromCjs(x) {
-  return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, "default") ? x["default"] : x;
-}
 const name = "@_sh/strapi-plugin-ckeditor";
-const version = "4.0.10";
-const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Unofficial integration)";
+const version = "5.0.0";
+const description = "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)";
 const keywords = [
   "strapi",
   "ckeditor",
@@ -25,80 +19,109 @@ const repository = {
   type: "git",
   url: "https://github.com/nshenderov/strapi-plugin-ckeditor.git"
 };
-const strapi$1 = {
+const strapi = {
   name: "ckeditor5",
   displayName: "CKEditor 5",
-  description: "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Unofficial integration)",
+  description: "Integrates CKEditor 5 into your Strapi project as a fully customizable custom field. (Community Edition)",
   kind: "plugin"
 };
+const type = "commonjs";
 const exports$1 = {
   "./package.json": "./package.json",
+  ".": {
+    types: "./dist/admin/src/index.d.ts",
+    source: "./admin/src/index.ts",
+    "import": "./dist/admin/index.mjs",
+    require: "./dist/admin/index.js",
+    "default": "./dist/admin/index.js"
+  },
   "./strapi-admin": {
-    source: "./admin/src/index.js",
+    types: "./dist/admin/src/index.d.ts",
+    source: "./admin/src/index.ts",
     "import": "./dist/admin/index.mjs",
     require: "./dist/admin/index.js",
     "default": "./dist/admin/index.js"
   },
   "./strapi-server": {
-    source: "./server/src/index.js",
+    types: "./dist/server/src/index.d.ts",
+    source: "./server/src/index.ts",
     "import": "./dist/server/index.mjs",
     require: "./dist/server/index.js",
     "default": "./dist/server/index.js"
   }
 };
 const files = [
-  "dist",
-  "./strapi-server.js"
+  "dist"
 ];
 const scripts = {
   build: "strapi-plugin build",
   watch: "strapi-plugin watch",
   "watch:link": "strapi-plugin watch:link",
   verify: "strapi-plugin verify",
+  "test:ts:front": "run -T tsc -p admin/tsconfig.json",
+  "test:ts:back": "run -T tsc -p server/tsconfig.json",
   release: "release-it",
   "release:info": "release-it --changelog"
 };
 const dependencies = {
-  ckeditor5: "^43.3.1",
-  "@ckeditor/ckeditor5-react": "^9.3.1",
-  "@strapi/design-system": "^2.0.0-rc.11",
+  "@ckeditor/ckeditor5-react": "^9.4.0",
+  "@strapi/design-system": "^2.0.0-rc.13",
+  "@strapi/icons": "^2.0.0-rc.13",
+  lodash: "^4.17.21",
+  ckeditor5: "^44.0.0",
   "prop-types": "^15.8.1",
-  "sanitize-html": "^2.13.1"
+  "sanitize-html": "^2.13.1",
+  yup: "0.32.9"
 };
 const devDependencies = {
+  "@release-it/conventional-changelog": "^8.0.1",
+  "@strapi/sdk-plugin": "^5.2.7",
   "@strapi/strapi": "^5.0.0",
-  "@strapi/sdk-plugin": "^5.2.6",
-  prettier: "^3.3.3",
+  "@strapi/typescript-utils": "^5.4.0",
+  "@types/react": "^18.3.12",
+  "@types/react-dom": "^18.3.1",
+  "@types/sanitize-html": "^2.13.0",
+  "@typescript-eslint/eslint-plugin": "^7.0.0",
+  "@typescript-eslint/parser": "^7.0.0",
+  eslint: "^8.2.0",
+  "eslint-config-airbnb": "^19.0.4",
+  "eslint-config-airbnb-typescript": "^18.0.0",
+  "eslint-config-prettier": "^9.1.0",
+  "eslint-plugin-import": "^2.25.3",
+  "eslint-plugin-jsx-a11y": "^6.10.2",
+  "eslint-plugin-prettier": "^5.2.1",
+  "eslint-plugin-react": "^7.28.0",
+  "eslint-plugin-react-hooks": "^4.3.0",
+  prettier: "3.4.0",
   react: "^18.3.1",
   "react-dom": "^18.3.1",
   "react-router-dom": "^6.26.2",
-  "styled-components": "^6.1.13",
   "release-it": "^17.6.0",
-  "@release-it/conventional-changelog": "^8.0.1"
+  "styled-components": "^6.1.13",
+  typescript: "^5.6.3"
 };
 const peerDependencies = {
   "@strapi/strapi": "^5.0.0",
-  "@strapi/sdk-plugin": "^5.2.6",
-  react: "^18.3.1",
-  "react-dom": "^18.3.1",
-  "react-router-dom": "^6.26.2",
-  "styled-components": "^6.1.13"
+  react: "^18.0.0",
+  "react-dom": "^18.0.0",
+  "react-router-dom": "^6.0.0",
+  "styled-components": "^6.0.0"
 };
 const engines = {
-  node: ">=18.0.0 <=20.x.x",
+  node: ">=18.0.0 <=22.x.x",
   npm: ">=6.0.0"
 };
 const license = "MIT";
-const require$$0 = {
+const pluginPkg = {
   name,
   version,
   description,
-  "private": false,
   keywords,
   author,
   homepage,
   repository,
-  strapi: strapi$1,
+  strapi,
+  type,
   exports: exports$1,
   files,
   scripts,
@@ -108,94 +131,13 @@ const require$$0 = {
   engines,
   license
 };
-const pluginPkg = require$$0;
-var pluginId$2 = pluginPkg.strapi.name;
-const pluginId$1 = pluginId$2;
-var register$1 = ({ strapi: strapi2 }) => {
-  strapi2.customFields.register({
-    name: "CKEditor",
-    plugin: pluginId$1,
-    type: "richtext"
-  });
-};
-const pluginId = pluginId$2;
-var config$3 = {
-  getConfig: async (ctx) => {
-    const { responsiveDimensions = false } = await strapi.plugin("upload").service("upload").getSettings();
-    const config2 = await strapi.plugin(pluginId).service("config").getConfig() + `
-globalThis.SH_CKE_UPLOAD_ADAPTER_IS_RESPONSIVE = ${responsiveDimensions}`;
-    ctx.type = "application/javascript";
-    ctx.send(config2);
-  }
-};
-const config$2 = config$3;
-var controllers$1 = {
-  config: config$2
-};
-var routes$1 = {
-  config: {
-    type: "admin",
-    routes: [
-      {
-        method: "GET",
-        path: "/config/ckeditor",
-        handler: "config.getConfig",
-        config: {
-          auth: false
-        }
-      }
-    ]
+const index = {
+  register: ({ strapi: strapi2 }) => {
+    strapi2.customFields.register({
+      name: "CKEditor",
+      plugin: pluginPkg.strapi.name,
+      type: "richtext"
+    });
   }
 };
-const fs = require$$0__default.default;
-var config$1 = ({ strapi: strapi2 }) => {
-  const readConfigFile = () => {
-    const appDir = process.cwd();
-    const isTSProject = fs.existsSync(`${appDir}/dist`);
-    const envName = process.env.NODE_ENV;
-    const cfgDir = isTSProject ? `${appDir}/dist/config` : `${appDir}/config`;
-    const cfgFileName = "ckeditor.js";
-    const envFilePath = `${cfgDir}/env/${envName}/${cfgFileName}`;
-    const baseFilePath = `${cfgDir}/${cfgFileName}`;
-    if (fs.existsSync(envFilePath)) {
-      return fs.readFileSync(envFilePath, "utf8");
-    } else if (fs.existsSync(baseFilePath)) {
-      return fs.readFileSync(baseFilePath, "utf8");
-    } else {
-      return null;
-    }
-  };
-  const trimConfig = (str) => {
-    for (const func of ["const CKEConfig", "function CKEConfig"]) {
-      const idx = str.indexOf(func);
-      if (idx >= 0) {
-        return str.substring(idx) + `
-globalThis.SH_CKE_CONFIG = CKEConfig()`;
-      }
-    }
-  };
-  return {
-    getConfig() {
-      const configFileContent = readConfigFile();
-      const config2 = configFileContent && trimConfig(configFileContent);
-      return config2 || `globalThis.SH_CKE_CONFIG = null`;
-    }
-  };
-};
-const config = config$1;
-var services$1 = {
-  config
-};
-const register = register$1;
-const controllers = controllers$1;
-const routes = routes$1;
-const services = services$1;
-var src = {
-  register,
-  controllers,
-  routes,
-  services
-};
-const index = /* @__PURE__ */ getDefaultExportFromCjs(src);
 module.exports = index;
-//# sourceMappingURL=index.js.map