Merge branch 'development'

Author: Bohdan-Chui

CHANGELOG.md

@@ -1,5 +1,9 @@
 # WProofreader SDK JavaScript Changelog
 
+## 1.1.0 – 2024-05-03
+
+* Added basic TypeScript support.
+
 ## 1.0.2 – 2023-09-29
 
 * Added examples of WProofreader SDK integration with rich text editors such as CKEditor 4, TinyMCE, Froala, and Quill in Vue.js, React and Angular frameworks.

README.md

@@ -62,7 +62,7 @@ npm install @webspellchecker/wproofreader-sdk-js
 
 	#### Option С: Using `init` method
 
-	Use `init` method to inialize WProofreader in a container. You can specify the other configuration options for the local initialization if needed. Or skip using `configure` method all together and set all the options directly in the `init` method.
+	Use `init` method to initialize WProofreader in a container. You can specify the other configuration options for the local initialization if needed. Or skip using `configure` method all together and set all the options directly in the `init` method.
 
 	```js
 	WProofreaderSDK.init({
@@ -104,7 +104,7 @@ npm install @webspellchecker/wproofreader-sdk-js
 ## Features
 * AI-powered sentence checker for multilingual spelling, grammar, and style check with enhanced accuracy in 20+ languages, including English, German, and Spanish.
 * Flags non-inclusive or profane English terms, suggesting unbiased alternatives.
-* Combines spelling autocorrector and autocomplete suggestions for quicker and error-free writing, primarily in English dialects.
+* Combines spelling autocorrect and autocomplete suggestions for quicker and error-free writing, primarily in English dialects.
 * Ensures data security with on-premise deployment options and allows user-centric customization including theme and language settings.
 * Enables the creation of custom dictionaries and industry-specific vocabularies, providing users with more accurate results.
 * Complies with WCAG 2.1 and Section 508 standards, featuring an accessible interface with real-time proofreading and keyboard navigation options.

index.d.ts

@@ -0,0 +1,14 @@
+declare module '@webspellchecker/wproofreader-sdk-js'
+
+declare interface WProofreaderSDK {
+    init(options: object): Promise<unknown>;
+    configure(options: object): Promise<void>;
+}
+
+declare namespace WEBSPELLCHECKER {
+    function destroyAll(): void;
+    function getInstances(): Array<unknown>;
+    function init(options: object, callbackSuccess: (instance: unknown) => void, callbackError: (error: string) => void): unknown;
+    function startAutoSearch(): void;
+    function stopAutoSearch(): void;
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@webspellchecker/wproofreader-sdk-js",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "WProofreader SDK package to simplify the integration into modern JavaScript applications.",
   "repository": {
     "type": "git",
@@ -19,8 +19,10 @@
   "license": "Apache-2.0",
   "main": "src/wproofreadersdk.js",
   "files": [
-    "src"
+    "src",
+    "index.d.ts"
   ],
+  "types": "index.d.ts",
   "keywords": [
     "WProofreader",
     "WebSpellChecker",