@ckeditor/ckeditor5-cloud-services 37.0.0-alpha.0 → 37.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ckeditor/ckeditor5-cloud-services",
3
- "version": "37.0.0-alpha.0",
3
+ "version": "37.0.0-alpha.2",
4
4
  "description": "CKEditor 5's Cloud Services integration layer.",
5
5
  "keywords": [
6
6
  "ckeditor",
@@ -11,14 +11,14 @@
11
11
  ],
12
12
  "main": "src/index.js",
13
13
  "dependencies": {
14
- "ckeditor5": "^37.0.0-alpha.0"
14
+ "ckeditor5": "^37.0.0-alpha.2"
15
15
  },
16
16
  "devDependencies": {
17
- "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
18
- "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
19
- "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
20
- "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
21
- "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
17
+ "@ckeditor/ckeditor5-core": "^37.0.0-alpha.2",
18
+ "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
19
+ "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.2",
20
+ "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.2",
21
+ "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.2",
22
22
  "typescript": "^4.8.4",
23
23
  "webpack": "^5.58.1",
24
24
  "webpack-cli": "^4.9.0"
@@ -47,7 +47,7 @@
47
47
  ],
48
48
  "scripts": {
49
49
  "dll:build": "webpack",
50
- "build": "tsc -p ./tsconfig.release.json",
50
+ "build": "tsc -p ./tsconfig.json",
51
51
  "postversion": "npm run build"
52
52
  },
53
53
  "types": "src/index.d.ts"
@@ -0,0 +1,19 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import type { CloudServices, CloudServicesConfig, CloudServicesCore } from './index';
6
+ declare module '@ckeditor/ckeditor5-core' {
7
+ interface EditorConfig {
8
+ /**
9
+ * The configuration of CKEditor Cloud Services. Introduced by the {@link module:cloud-services/cloudservices~CloudServices} plugin.
10
+ *
11
+ * Read more in {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig}.
12
+ */
13
+ cloudServices?: CloudServicesConfig;
14
+ }
15
+ interface PluginsMap {
16
+ [CloudServices.pluginName]: CloudServices;
17
+ [CloudServicesCore.pluginName]: CloudServicesCore;
18
+ }
19
+ }
@@ -0,0 +1,5 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ export {};
@@ -81,8 +81,3 @@ export default class CloudServices extends ContextPlugin implements CloudService
81
81
  */
82
82
  destroy(): void;
83
83
  }
84
- declare module '@ckeditor/ckeditor5-core' {
85
- interface PluginsMap {
86
- [CloudServices.pluginName]: CloudServices;
87
- }
88
- }
@@ -119,13 +119,3 @@ export interface CloudServicesConfig {
119
119
  */
120
120
  bundleVersion?: string;
121
121
  }
122
- declare module '@ckeditor/ckeditor5-core' {
123
- interface EditorConfig {
124
- /**
125
- * The configuration of CKEditor Cloud Services. Introduced by the {@link module:cloud-services/cloudservices~CloudServices} plugin.
126
- *
127
- * Read more in {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig}.
128
- */
129
- cloudServices?: CloudServicesConfig;
130
- }
131
- }
@@ -18,10 +18,10 @@ export default class CloudServicesCore extends ContextPlugin {
18
18
  */
19
19
  static get pluginName(): 'CloudServicesCore';
20
20
  /**
21
- * Creates the {@link module:cloud-services/token~Token} instance.
21
+ * Creates the {@link module:cloud-services/token/token~Token} instance.
22
22
  *
23
23
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
24
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
24
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
25
25
  * @param options.initValue Initial value of the token.
26
26
  * @param options.autoRefresh Specifies whether to start the refresh automatically.
27
27
  */
@@ -34,8 +34,3 @@ export default class CloudServicesCore extends ContextPlugin {
34
34
  */
35
35
  createUploadGateway(token: InitializedToken, apiAddress: string): UploadGateway;
36
36
  }
37
- declare module '@ckeditor/ckeditor5-core' {
38
- interface PluginsMap {
39
- [CloudServicesCore.pluginName]: CloudServicesCore;
40
- }
41
- }
@@ -19,10 +19,10 @@ export default class CloudServicesCore extends ContextPlugin {
19
19
  return 'CloudServicesCore';
20
20
  }
21
21
  /**
22
- * Creates the {@link module:cloud-services/token~Token} instance.
22
+ * Creates the {@link module:cloud-services/token/token~Token} instance.
23
23
  *
24
24
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
25
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
25
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
26
26
  * @param options.initValue Initial value of the token.
27
27
  * @param options.autoRefresh Specifies whether to start the refresh automatically.
28
28
  */
package/src/index.d.ts CHANGED
@@ -7,7 +7,8 @@
7
7
  */
8
8
  export { default as CloudServices } from './cloudservices';
9
9
  export { default as CloudServicesCore } from './cloudservicescore';
10
- export { TokenUrl } from './cloudservicesconfig';
10
+ export { TokenUrl, type CloudServicesConfig } from './cloudservicesconfig';
11
11
  export type { default as Token, InitializedToken } from './token/token';
12
12
  export type { default as UploadGateway } from './uploadgateway/uploadgateway';
13
13
  export type { default as FileUploader } from './uploadgateway/fileuploader';
14
+ import './augmentation';
package/src/index.js CHANGED
@@ -7,3 +7,4 @@
7
7
  */
8
8
  export { default as CloudServices } from './cloudservices';
9
9
  export { default as CloudServicesCore } from './cloudservicescore';
10
+ import './augmentation';
@@ -17,7 +17,7 @@ export default class Token extends Token_base {
17
17
  * The value of the token is undefined if `initValue` is not provided or `init` method was not called.
18
18
  * `create` method creates token with initialized value from url.
19
19
  *
20
- * @see module:cloud-services/token~InitializedToken
20
+ * @see module:cloud-services/token/token~InitializedToken
21
21
  * @observable
22
22
  * @readonly
23
23
  */
@@ -33,7 +33,7 @@ export default class Token extends Token_base {
33
33
  * Method `init` should be called after using the constructor or use `create` method instead.
34
34
  *
35
35
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
36
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
36
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
37
37
  */
38
38
  constructor(tokenUrlOrRefreshToken: TokenUrl, options?: TokenOptions);
39
39
  /**
@@ -65,10 +65,10 @@ export default class Token extends Token_base {
65
65
  */
66
66
  private _getTokenRefreshTimeoutTime;
67
67
  /**
68
- * Creates a initialized {@link module:cloud-services/token~Token} instance.
68
+ * Creates a initialized {@link module:cloud-services/token/token~Token} instance.
69
69
  *
70
70
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
71
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
71
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
72
72
  */
73
73
  static create(tokenUrlOrRefreshToken: TokenUrl, options?: TokenOptions): Promise<InitializedToken>;
74
74
  }
@@ -3,7 +3,7 @@
3
3
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
4
  */
5
5
  /**
6
- * @module cloud-services/token
6
+ * @module cloud-services/token/token
7
7
  */
8
8
  /* globals XMLHttpRequest, setTimeout, clearTimeout, atob */
9
9
  import { ObservableMixin, CKEditorError } from 'ckeditor5/src/utils';
@@ -19,7 +19,7 @@ export default class Token extends ObservableMixin() {
19
19
  * Method `init` should be called after using the constructor or use `create` method instead.
20
20
  *
21
21
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
22
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
22
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
23
23
  */
24
24
  constructor(tokenUrlOrRefreshToken, options = {}) {
25
25
  super();
@@ -132,10 +132,10 @@ export default class Token extends ObservableMixin() {
132
132
  }
133
133
  }
134
134
  /**
135
- * Creates a initialized {@link module:cloud-services/token~Token} instance.
135
+ * Creates a initialized {@link module:cloud-services/token/token~Token} instance.
136
136
  *
137
137
  * @param tokenUrlOrRefreshToken Endpoint address to download the token or a callback that provides the token. If the
138
- * value is a function it has to match the {@link module:cloud-services/token~refreshToken} interface.
138
+ * value is a function it has to match the {@link module:cloud-services/token/token~Token#refreshToken} interface.
139
139
  */
140
140
  static create(tokenUrlOrRefreshToken, options = {}) {
141
141
  const token = new Token(tokenUrlOrRefreshToken, options);
@@ -71,7 +71,7 @@ export default class FileUploader extends FileUploader_base {
71
71
  /**
72
72
  * Fired when error occurs.
73
73
  *
74
- * @eventName error
74
+ * @eventName ~FileUploader#error
75
75
  * @param error Error message
76
76
  */
77
77
  export type FileUploaderErrorEvent = {
@@ -81,7 +81,7 @@ export type FileUploaderErrorEvent = {
81
81
  /**
82
82
  * Fired on upload progress.
83
83
  *
84
- * @eventName progress
84
+ * @eventName ~FileUploader#progress
85
85
  * @param status Total and uploaded status
86
86
  */
87
87
  export type FileUploaderProgressErrorEvent = {