Merge pull request #317 from ckeditor/remove-ckeditor5-premium-features-from-peer-dependencies

Fix: Improve ESM support by adding missing file extensions in imports.

Other: Remove `ckeditor5-premium-features` from `peerDependencies`.

Author: filipsobol

.eslintrc.cjs

@@ -24,6 +24,12 @@ module.exports = {
 			' * For licensing, see LICENSE.md.',
 			' */'
 		] } ],
+		'ckeditor5-rules/require-file-extensions-in-imports': [
+			'error',
+			{
+				extensions: [ '.ts', '.js', '.json' ]
+			}
+		],
 		'ckeditor5-rules/prevent-license-key-leak': 'error',
 		'vue/multi-word-component-names': 'off',
 		'no-unused-vars': 'off',

demos/editor-cdn/App.vue

@@ -38,7 +38,7 @@
 
 <script setup lang="ts">
 import { ref, reactive, computed } from 'vue';
-import useCKEditorCloud from '../../src/useCKEditorCloud';
+import useCKEditorCloud from '../../src/useCKEditorCloud.js';
 import type { EventInfo, ClassicEditor } from 'https://cdn.ckeditor.com/typings/ckeditor5.d.ts';
 
 // Load CKEditor from the CDN

package.json

@@ -31,11 +31,10 @@
   },
   "dependencies": {
     "lodash-es": "^4.17.21",
-    "@ckeditor/ckeditor5-integrations-common": "^2.0.0"
+    "@ckeditor/ckeditor5-integrations-common": "^2.1.0"
   },
   "peerDependencies": {
     "ckeditor5": ">=42.0.0 || ^0.0.0-nightly",
-    "ckeditor5-premium-features": ">=42.0.0 || ^0.0.0-nightly",
     "vue": "^3.4.0"
   },
   "devDependencies": {
@@ -65,7 +64,7 @@
     "vitest": "^2.0.0",
     "vue": "^3.4.30",
     "vue-eslint-parser": "^9.1.0",
-    "vue-tsc": "^2.0.22",
+    "vue-tsc": "^2.1.6",
     "webdriverio": "^8.39.0"
   },
   "resolutions": {
@@ -79,7 +78,7 @@
   },
   "scripts": {
     "dev": "vite",
-    "build": "vite build && vue-tsc --declaration --emitDeclarationOnly",
+    "build": "tsc --noEmit && vite build && vue-tsc --emitDeclarationOnly",
     "test": "vitest run --coverage",
     "test:watch": "vitest --ui --watch",
     "test:check:types": "tsc --noEmit -p ./tests/tsconfig.json",

src/plugin.ts

@@ -42,7 +42,7 @@ export {
  * CDN related exports.
  */
 
-export { default as useCKEditorCloud } from './useCKEditorCloud';
+export { default as useCKEditorCloud } from './useCKEditorCloud.js';
 
 export {
 	loadCKEditorCloud,

src/shims-vue.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+declare module '*.vue';

src/useCKEditorCloud.ts

@@ -4,7 +4,7 @@
  */
 
 import { toValue, type MaybeRefOrGetter } from 'vue';
-import { useAsync, type AsyncComposableResult } from './composables/useAsync';
+import { useAsync, type AsyncComposableResult } from './composables/useAsync.js';
 
 import {
 	loadCKEditorCloud,

tests/ckeditor.test.ts

@@ -6,12 +6,12 @@
 import { nextTick } from 'vue';
 import { describe, beforeEach, afterEach, it, expect, vi } from 'vitest';
 import { mount } from '@vue/test-utils';
-import { Ckeditor } from '../src/plugin';
+import { Ckeditor } from '../src/plugin.js';
 import {
 	MockEditor,
 	ModelDocument,
 	ViewDocument
-} from './_utils/mockeditor';
+} from './_utils/mockeditor.js';
 
 describe( 'CKEditor component', () => {
 	beforeEach( () => {

tests/composables/useAsync.test.ts

@@ -8,7 +8,7 @@ import { ref } from 'vue';
 import { flushPromises } from '@vue/test-utils';
 
 import { createDefer } from '@ckeditor/ckeditor5-integrations-common';
-import { useAsync } from '../../src/composables/useAsync';
+import { useAsync } from '../../src/composables/useAsync.js';
 
 describe( 'useAsync', () => {
 	it( 'should call async function and return the result in data ref', async () => {

tests/plugin/localcomponent.test.ts

@@ -7,7 +7,7 @@ import { nextTick } from 'vue';
 import { describe, it, expect } from 'vitest';
 import { mount } from '@vue/test-utils';
 import { Ckeditor } from '../../src/plugin.js';
-import { MockEditor } from '../_utils/mockeditor';
+import { MockEditor } from '../_utils/mockeditor.js';
 
 class FooEditor extends MockEditor {}
 

tests/useCKEditorCloud.test.ts

@@ -10,7 +10,7 @@ import { ref } from 'vue';
 import { removeAllCkCdnResources } from '@ckeditor/ckeditor5-integrations-common/test-utils';
 import type { CKEditorCloudConfig } from '@ckeditor/ckeditor5-integrations-common';
 
-import useCKEditorCloud from '../src/useCKEditorCloud';
+import useCKEditorCloud from '../src/useCKEditorCloud.js';
 
 describe( 'useCKEditorCloud', () => {
 	beforeEach( removeAllCkCdnResources );