Merge pull request #362 from splitio/refactor_type_definitions

Refactor TypeScript declarations

Author: EmilianoSanchez

.eslintrc

@@ -5,6 +5,7 @@
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
+    "eslint-plugin-tsdoc",
     "import"
   ],
 
@@ -90,6 +91,19 @@
         "sourceType": "module"
       }
     },
+    {
+      "files": ["types/**"],
+      "rules": {
+        "no-use-before-define": "off"
+      }
+    },
+    {
+      // Enable TSDoc rules for TypeScript files, allowing the use of JSDoc in JS files.
+      "files": ["**/*.ts"],
+      "rules": {
+        "tsdoc/syntax": "warn"
+      }
+    },
     // @TODO remove when moving InLocalStorage to js-browser
     {
       "files": ["src/storages/inLocalStorage/**/*.ts"],

.gitignore

@@ -9,7 +9,6 @@
 ## transpiled code
 /esm
 /cjs
-/types
 
 ## coverage info
 /coverage

CHANGES.txt

@@ -1,6 +1,7 @@
 2.0.0 (October XX, 2024)
  - Added support for targeting rules based on large segments.
  - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+ - Added `SplitIO` namespace with the public TypeScript definitions to be reused by the SDKs, rather than having each SDK define its own types.
  - Updated the handling of timers and async operations inside an `init` factory method to enable lazy initialization of the SDK in standalone mode. This update is intended for the React SDK.
  - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
  - BREAKING CHANGES: