@ckeditor/ckeditor5-adapter-ckfinder 36.0.1 → 37.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-adapter-ckfinder",
-  "version": "36.0.1",
+  "version": "37.0.0-alpha.0",
   "description": "CKFinder adapter for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,23 +12,23 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "^36.0.1"
+    "ckeditor5": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.1",
-    "@ckeditor/ckeditor5-core": "^36.0.1",
-    "@ckeditor/ckeditor5-clipboard": "^36.0.1",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.1",
-    "@ckeditor/ckeditor5-enter": "^36.0.1",
-    "@ckeditor/ckeditor5-heading": "^36.0.1",
-    "@ckeditor/ckeditor5-image": "^36.0.1",
-    "@ckeditor/ckeditor5-list": "^36.0.1",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.1",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.1",
-    "@ckeditor/ckeditor5-typing": "^36.0.1",
-    "@ckeditor/ckeditor5-undo": "^36.0.1",
-    "@ckeditor/ckeditor5-upload": "^36.0.1",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-clipboard": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-typing": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-upload": "^37.0.0-alpha.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -59,5 +59,6 @@
     "dll:build": "webpack",
     "build": "tsc -p ./tsconfig.release.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module adapter-ckfinder
+ */
+export { default as UploadAdapter } from './uploadadapter';

package/src/uploadadapter.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module adapter-ckfinder/uploadadapter
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * A plugin that enables file uploads in CKEditor 5 using the CKFinder server–side connector.
+ *
+ * See the {@glink features/file-management/ckfinder "CKFinder file manager integration"} guide to learn how to configure
+ * and use this feature as well as find out more about the full integration with the file manager
+ * provided by the {@link module:ckfinder/ckfinder~CKFinder} plugin.
+ *
+ * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload overview"} guide to learn
+ * about other ways to upload images into CKEditor 5.
+ */
+export default class CKFinderUploadAdapter extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'CKFinderUploadAdapter';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/uploadadapter.js

@@ -12,12 +12,12 @@ import { getCsrfToken } from './utils';
 /**
  * A plugin that enables file uploads in CKEditor 5 using the CKFinder server–side connector.
  *
- * See the {@glink features/images/image-upload/ckfinder "CKFinder file manager integration" guide} to learn how to configure
+ * See the {@glink features/file-management/ckfinder "CKFinder file manager integration"} guide to learn how to configure
  * and use this feature as well as find out more about the full integration with the file manager
  * provided by the {@link module:ckfinder/ckfinder~CKFinder} plugin.
  *
- * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload overview"} to learn about
- * other ways to upload images into CKEditor 5.
+ * Check out the {@glink features/images/image-upload/image-upload comprehensive "Image upload overview"} guide to learn
+ * about other ways to upload images into CKEditor 5.
  */
 export default class CKFinderUploadAdapter extends Plugin {
     /**

package/src/utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Returns the CSRF token value. The value is a hash stored in `document.cookie`
+ * under the `ckCsrfToken` key. The CSRF token can be used to secure the communication
+ * between the web browser and the CKFinder server.
+ */
+export declare function getCsrfToken(): string;
+/**
+ * Returns the value of the cookie with a given name or `null` if the cookie is not found.
+ */
+export declare function getCookie(name: string): string | null;
+/**
+ * Sets the value of the cookie with a given name.
+ */
+export declare function setCookie(name: string, value: string): void;