@ckeditor/ckeditor5-easy-image - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0-alpha.1

package.json

 {
   "name": "@ckeditor/ckeditor5-easy-image",
-  "version": "0.0.1",
+  "version": "1.0.0-alpha.1",
   "description": "Easy Image feature for CKEditor 5.",
@@ -11,11 +11,11 @@ "keywords": [
     "@ckeditor/ckeditor-cloudservices-core": "^0.1.0",
-    "@ckeditor/ckeditor5-core": "^0.9.0",
-    "@ckeditor/ckeditor5-image": "^0.7.0",
-    "@ckeditor/ckeditor5-upload": "^0.2.0"
+    "@ckeditor/ckeditor5-core": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-image": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-upload": "^1.0.0-alpha.1"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-dev-lint": "^3.1.0",
-    "@ckeditor/ckeditor5-editor-classic": "^0.8.0",
-    "@ckeditor/ckeditor5-paragraph": "^0.9.0",
-    "@ckeditor/ckeditor5-utils": "^0.10.0",
+    "@ckeditor/ckeditor5-dev-lint": "^3.1.4",
+    "@ckeditor/ckeditor5-editor-classic": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-paragraph": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "^1.0.0-alpha.1",
     "eslint-config-ckeditor5": "^1.0.6",
@@ -22,0 +22,0 @@ "gulp": "^3.9.1",

README.md

@@ -11,10 +11,12 @@ CKEditor 5 Easy Image with Cloud Services
 
-Easy Image feature for CKEditor 5.
+This package implements the [Easy Image](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/features/image.html#Image-upload) feature for CKEditor 5.
 
-Easy Image plugin which lets you easily insert images into the editor and integrates automatically with CKEditor Cloud Services.
+Easy Image lets you easily insert images into the editor and integrates automatically with [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/).
 
-More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-easy-image>.
+## Documentation
 
+See the [`@ckeditor/ckeditor5-easy-image` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/easy-image.html) page in [CKEditor 5 documentation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/).
+
 ## License
 
 Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the `LICENSE.md` file.

src/cloudservicesuploadadapter.js

@@ -14,3 +14,16 @@ /**
 
+/**
+ * A plugin which enables upload to Cloud Services.
+ *
+ * It is mainly used by the {@link module:easy-image/easyimage~EasyImage} feature.
+ *
+ * After enabling this adapter you need to configure the Cloud Services integration through
+ * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig `config.cloudServices`}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class CloudServicesUploadAdapter extends Plugin {
+	/**
+	 * @inheritDoc
+	 */
 	static get requires() {
@@ -20,2 +33,5 @@ return [ FileRepository ];
 
+	/**
+	 * @inheritDoc
+	 */
 	init() {
@@ -25,6 +41,7 @@ const editor = this.editor;
 
+		config.define( 'cloudServices.uploadUrl', 'https://files.cke-cs.com/upload/' );
+
 		const token = config.get( 'cloudServices.token' );
 		const uploadUrl = config.get( 'cloudServices.uploadUrl' );
 
-		// Application is in offline mode.
 		if ( !token || !uploadUrl ) {
@@ -42,2 +59,5 @@ return;
 
+/**
+ * @private
+ */
 class Adapter {
@@ -69,1 +89,44 @@ constructor( uploadGateway, loader ) {
 CloudServicesUploadAdapter._UploadGateway = UploadGateway;
+
+/**
+ * The configuration of the {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter Cloud Services upload adapter}.
+ *
+ * It is used mainly by the {@link module:easy-image/easyimage~EasyImage} feature.
+ *
+ * Read more in {@link module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig}.
+ *
+ * @member {module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig}
+ *         module:core/editor/editorconfig~EditorConfig#cloudServices
+ */
+
+/**
+ * The configuration of the {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter Cloud Services upload adapter}.
+ *
+ * It is used mainly by the {@link module:easy-image/easyimage~EasyImage} feature.
+ *
+ *		ClassicEditor
+ *			.create( editorElement, {
+ * 				cloudServices: {
+ *					token: '...',
+ *					uploadUrl: 'https://files.cke-cs.com/upload/'
+ * 				}
+ *			} )
+ *			.then( ... )
+ *			.catch( ... );
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ *
+ * @interface CloudServicesAdapterConfig
+ */
+
+/**
+ * The URL to which the files should be uploaded.
+ *
+ * @member {String} module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig#uploadUrl
+ */
+
+/**
+ * The token to the Cloud Services application. You can obtain it from the token service.
+ *
+ * @member {String} module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig#token
+ */

src/easyimage.js

@@ -15,2 +15,16 @@ /**
 
+/**
+ * The Easy Image feature.
+ *
+ * This plugin enables:
+ *
+ * * {@link module:image/image~Image},
+ * * {@link module:upload/imageupload~ImageUpload},
+ * * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter}.
+ *
+ * After enabling the Easy Image plugin you need to configure the Cloud Services integration through
+ * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesAdapterConfig `config.cloudServices`}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
 export default class EasyImage extends Plugin {
@@ -17,0 +31,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9570

increased by43.01%

Number of package files

6

increased by20%

Lines of code

150

increased by92.31%

Number of lines in readme file

22

increased by10%

Dependency changes

• + Added@ckeditor/ckeditor5-core@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-engine@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-image@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-theme-lark@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-ui@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-upload@1.0.0-beta.4(transitive)

• + Added@ckeditor/ckeditor5-widget@1.0.0-beta.4(transitive)

• - Removed@ckeditor/ckeditor5-core@0.9.0(transitive)

• - Removed@ckeditor/ckeditor5-engine@0.11.0(transitive)

• - Removed@ckeditor/ckeditor5-image@0.7.0(transitive)

• - Removed@ckeditor/ckeditor5-theme-lark@0.9.0(transitive)

• - Removed@ckeditor/ckeditor5-ui@0.10.0(transitive)

• - Removed@ckeditor/ckeditor5-upload@0.2.0(transitive)

• - Removed@ckeditor/ckeditor5-utils@0.10.0(transitive)

• - Removed@ckeditor/ckeditor5-widget@0.2.0(transitive)

• Updated@ckeditor/ckeditor5-core@^1.0.0-alpha.1

• Updated@ckeditor/ckeditor5-image@^1.0.0-alpha.1

• Updated@ckeditor/ckeditor5-upload@^1.0.0-alpha.1