@ckeditor/ckeditor5-cloud-services 41.2.0 → 41.3.0-alpha.1

package/dist/types/uploadgateway/fileuploader.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @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
+ */
+/**
+ * @module cloud-services/uploadgateway/fileuploader
+ */
+import type { UploadResponse } from 'ckeditor5/src/upload.js';
+import type { InitializedToken } from '../token/token.js';
+declare const FileUploader_base: {
+    new (): import("ckeditor5/src/utils.js").Emitter;
+    prototype: import("ckeditor5/src/utils.js").Emitter;
+};
+/**
+ * FileUploader class used to upload single file.
+ */
+export default class FileUploader extends FileUploader_base {
+    /**
+     * A file that is being uploaded.
+     */
+    readonly file: Blob;
+    xhr?: XMLHttpRequest;
+    /**
+     * CKEditor Cloud Services access token.
+     */
+    private readonly _token;
+    /**
+     * CKEditor Cloud Services API address.
+     */
+    private readonly _apiAddress;
+    /**
+     * Creates `FileUploader` instance.
+     *
+     * @param fileOrData A blob object or a data string encoded with Base64.
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    constructor(fileOrData: string | Blob, token: InitializedToken, apiAddress: string);
+    /**
+     * Registers callback on `progress` event.
+     */
+    onProgress(callback: (status: {
+        total: number;
+        uploaded: number;
+    }) => void): this;
+    /**
+     * Registers callback on `error` event. Event is called once when error occurs.
+     */
+    onError(callback: (error: string) => void): this;
+    /**
+     * Aborts upload process.
+     */
+    abort(): void;
+    /**
+     * Sends XHR request to API.
+     */
+    send(): Promise<UploadResponse>;
+    /**
+     * Prepares XHR request.
+     */
+    private _prepareRequest;
+    /**
+     * Attaches listeners to the XHR.
+     */
+    private _attachXHRListeners;
+    /**
+     * Sends XHR request.
+     */
+    private _sendRequest;
+}
+/**
+ * Fired when error occurs.
+ *
+ * @eventName ~FileUploader#error
+ * @param error Error message
+ */
+export type FileUploaderErrorEvent = {
+    name: 'error';
+    args: [error: string];
+};
+/**
+ * Fired on upload progress.
+ *
+ * @eventName ~FileUploader#progress
+ * @param status Total and uploaded status
+ */
+export type FileUploaderProgressErrorEvent = {
+    name: 'progress';
+    args: [status: {
+        total: number;
+        uploaded: number;
+    }];
+};
+export {};

package/dist/types/uploadgateway/uploadgateway.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @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
+ */
+/**
+ * @module cloud-services/uploadgateway/uploadgateway
+ */
+import FileUploader from './fileuploader.js';
+import type { InitializedToken } from '../token/token.js';
+/**
+ * UploadGateway abstracts file uploads to CKEditor Cloud Services.
+ */
+export default class UploadGateway {
+    /**
+     * CKEditor Cloud Services access token.
+     */
+    private readonly _token;
+    /**
+     * CKEditor Cloud Services API address.
+     */
+    private readonly _apiAddress;
+    /**
+     * Creates `UploadGateway` instance.
+     *
+     * @param token Token used for authentication.
+     * @param apiAddress API address.
+     */
+    constructor(token: InitializedToken, apiAddress: string);
+    /**
+     * Creates a {@link module:cloud-services/uploadgateway/fileuploader~FileUploader} instance that wraps
+     * file upload process. The file is being sent at a time when the
+     * {@link module:cloud-services/uploadgateway/fileuploader~FileUploader#send} method is called.
+     *
+     * ```ts
+     * const token = await Token.create( 'https://token-endpoint' );
+     * new UploadGateway( token, 'https://example.org' )
+     * 	.upload( 'FILE' )
+     * 	.onProgress( ( data ) => console.log( data ) )
+     * 	.send()
+     * 	.then( ( response ) => console.log( response ) );
+     * ```
+     *
+     * @param {Blob|String} fileOrData A blob object or a data string encoded with Base64.
+     * @returns {module:cloud-services/uploadgateway/fileuploader~FileUploader} Returns `FileUploader` instance.
+     */
+    upload(fileOrData: string | Blob): FileUploader;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-cloud-services",
-  "version": "41.2.0",
+  "version": "41.3.0-alpha.1",
   "description": "CKEditor 5's Cloud Services integration layer.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "ckeditor5": "41.2.0"
+    "ckeditor5": "41.3.0-alpha.1"
   },
   "author": "CKSource (http://cksource.com/)",
   "license": "GPL-2.0-or-later",
@@ -24,6 +24,7 @@
     "directory": "packages/ckeditor5-cloud-services"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/src/index.d.ts

@@ -7,7 +7,7 @@
  */
 export { default as CloudServices } from './cloudservices.js';
 export { default as CloudServicesCore } from './cloudservicescore.js';
-export { TokenUrl, type CloudServicesConfig } from './cloudservicesconfig.js';
+export type { TokenUrl, CloudServicesConfig } from './cloudservicesconfig.js';
 export type { default as Token, InitializedToken } from './token/token.js';
 export type { default as UploadGateway } from './uploadgateway/uploadgateway.js';
 export type { default as FileUploader } from './uploadgateway/fileuploader.js';