Merge pull request #742 from wazo-platform/WP-1265-ts-cleanup

[WP-1265] Typescript cleanup

.eslintignore

@@ -1,4 +1,5 @@
 dist/*
 docs/*
 esm/*
-lib/*
+lib/*
+./index.js

.eslintrc

@@ -89,4 +89,4 @@
       }
     }
   }
-}
+}

README.md

@@ -175,7 +175,7 @@ Alternatively, you may load the Wazo SDK from a CDN. Use one of the following Co
 ### Importing the Simple API
 ```js
 // For Node / packaged app
-import Wazo from '@wazo/sdk/lib/simple';
+import Wazo from '@wazo/sdk';
 
 // Browser
 // You can access the `Wazo` object directly on the browser, simply include it in the html :
@@ -747,7 +747,7 @@ client.auth.listPolicies();
 **`Log`**
 
 ```
-import Wazo from '@wazo/sdk/lib/simple';
+import Wazo from '@wazo/sdk';
 
 Wazo.IssueReporter.enable();
 Wazo.IssueReporter.configureRemoteClient({

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/index');

package.json

@@ -2,7 +2,8 @@
   "name": "@wazo/sdk",
   "version": "0.39.15",
   "description": "Wazo's JavaScript Software Development Kit.",
-  "main": "dist/wazo-sdk.js",
+  "main": "index.js",
+  "types": "lib/types/index.d.ts",
   "author": "Wazo (http://wazo.io)",
   "maintainers": [
     "Wazo Team <dev@wazo.io> (https://github.com/wazo-platform)"
@@ -13,6 +14,7 @@
   "license": "MIT",
   "homepage": "https://github.com/wazo-platform/wazo-js-sdk",
   "files": [
+    "index.js",
     "dist/*.js",
     "src/**/*",
     "esm/**/*",
@@ -39,21 +41,6 @@
     "typecheck": "./node_modules/.bin/tsc --noEmit",
     "prepublishOnly": "yarn build"
   },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./esm/types/index.d.ts",
-        "default": "./esm/index.mjs"
-      },
-      "require": {
-        "types": "./lib/types/index.d.ts",
-        "default": "./lib/index.js"
-      }
-    },
-    "./lib/": "./lib/",
-    "./lib/simple": "./lib/simple/index.js",
-    "./dist/wazo-sdk": "./dist/wazo-sdk.js"
-  },
   "dependencies": {
     "events": "^3.3.0",
     "fstream": "^1.0.12",
@@ -84,7 +71,7 @@
     "@types/jest": "^29.5.2",
     "@types/jsrsasign": "^10.5.8",
     "@types/node": "^20.4.0",
-    "@types/sdp-transform": "^2.4.6",
+    "@types/sdp-transform": "^2.4.9",
     "@typescript-eslint/eslint-plugin": "^5.61.0",
     "@typescript-eslint/parser": "^5.61.0",
     "babel-core": "^7.0.0-bridge.0",

src/__tests__/api-client.test.ts

@@ -88,8 +88,7 @@ client.setToken(token);
 describe('With correct API results', () => {
   beforeEach(() => {
     jest.resetModules();
-    // @ts-expect-error
-    global.fetch = jest.fn(() => Promise.resolve(mockedJson));
+    global.fetch = jest.fn(() => Promise.resolve(mockedJson)) as any;
   });
 
   describe('logIn test', () => {
@@ -102,13 +101,12 @@ describe('With correct API results', () => {
         Authorization: `Basic ${Base64.encode(`${username}:${password}`)}`,
         'Content-Type': 'application/json',
       };
-      // @ts-expect-error
+
       const result = await client.auth.logIn({
         username,
         password,
-      });
+      } as any) as any;
       expect(result).toBeInstanceOf(Session);
-      // @ts-expect-error
       expect(result.token).toBe(1);
       expect(global.fetch).toBeCalledWith(`https://${server}/api/auth/${authVersion}/token`, {
         method: 'post',
@@ -123,8 +121,7 @@ describe('With correct API results', () => {
   describe('logOut test', () => {
     it('should delete the specified token', async () => {
       const oldToken = 123;
-      // @ts-expect-error
-      await client.auth.logOut(oldToken);
+      await client.auth.logOut(oldToken as any);
       expect(global.fetch).toBeCalledWith(`https://${server}/api/auth/${authVersion}/token/${oldToken}`, {
         method: 'delete',
         body: null,
@@ -139,8 +136,7 @@ describe('With correct API results', () => {
 describe('With unAuthorized API results', () => {
   beforeEach(() => {
     jest.resetModules();
-    // @ts-expect-error
-    global.fetch = jest.fn(() => Promise.resolve(mockedUnAuthorized));
+    global.fetch = jest.fn(() => Promise.resolve(mockedUnAuthorized)) as any;
   });
 
   describe('checkLogin test', () => {
@@ -162,8 +158,7 @@ describe('With unAuthorized API results', () => {
 describe('With not found API results', () => {
   beforeEach(() => {
     jest.resetModules();
-    // @ts-expect-error
-    global.fetch = jest.fn(() => Promise.resolve(mockedNotFound));
+    global.fetch = jest.fn(() => Promise.resolve(mockedNotFound)) as any;
   });
 
   describe('fetchVoicemail test', () => {
@@ -198,19 +193,17 @@ describe('With not found API results', () => {
 describe('With erroneous text API results', () => {
   beforeEach(() => {
     jest.resetModules();
-    // @ts-expect-error
-    global.fetch = jest.fn(() => Promise.resolve(mockedTextError));
+    global.fetch = jest.fn(() => Promise.resolve(mockedTextError)) as any;
   });
 
   it('throw an exception when the response is >= 500', async () => {
     let error = null;
 
     try {
-      // @ts-expect-error
       await client.auth.logIn({
         username,
         password,
-      });
+      } as any);
     } catch (e: any) {
       error = e;
     }
@@ -225,19 +218,17 @@ describe('With erroneous text API results', () => {
 describe('With erroneous json API results', () => {
   beforeEach(() => {
     jest.resetModules();
-    // @ts-expect-error
-    global.fetch = jest.fn(() => Promise.resolve(mockedJsonError));
+    global.fetch = jest.fn(() => Promise.resolve(mockedJsonError)) as any;
   });
 
   it('throw an exception when the response is >= 500', async () => {
     let error = null;
 
     try {
-      // @ts-expect-error
       await client.auth.logIn({
         username,
         password,
-      });
+      } as any);
     } catch (e: any) {
       error = e;
     }

src/__tests__/web-rtc-client.test.ts

@@ -4,18 +4,15 @@ jest.mock('sip.js/lib/platform/web/transport');
 jest.mock('sip.js/lib/api/user-agent', () => ({
   start: () => {},
   UserAgent: class UserAgent {
-    // @ts-ignore
-    static makeURI = () => {};
+    static makeURI: () => null = () => null;
 
-    // @ts-ignore
     start = () => {};
 
     transport = {};
   },
 }));
 
-// @ts-expect-error
-const client = new WebRTCClient({});
+const client = new WebRTCClient({} as any, null, undefined);
 
 describe('WebRTC client', () => {
   it('should compute muted/unmuted state', async () => {
@@ -65,14 +62,11 @@ describe('WebRTC client', () => {
         },
       },
     };
-    // @ts-expect-error
-    expect(client.isAudioMuted(mutedSession)).toBeTruthy();
-    // @ts-expect-error
-    expect(client.isAudioMuted(oldKindMuted)).toBeTruthy();
-    // @ts-expect-error
-    expect(client.isAudioMuted(unMutedSession)).toBeFalsy();
-    // @ts-expect-error
-    expect(client.isAudioMuted(oldKindUnmuted)).toBeFalsy();
+
+    expect(client.isAudioMuted(mutedSession as any)).toBeTruthy();
+    expect(client.isAudioMuted(oldKindMuted as any)).toBeTruthy();
+    expect(client.isAudioMuted(unMutedSession as any)).toBeFalsy();
+    expect(client.isAudioMuted(oldKindUnmuted as any)).toBeFalsy();
   });
 });
 describe('changeAudioInputDevice', () => {
@@ -131,27 +125,21 @@ describe('changeAudioInputDevice', () => {
     },
   });
   it('should change the audio input track if the provided id is different', async () => {
-    // @ts-expect-error
-    client.setMediaConstraints(constraints);
+    client.setMediaConstraints(constraints as any);
     expect(client.getAudioDeviceId()).toBe(defaultId);
-    // @ts-expect-error
-    const result = await client.changeAudioInputDevice(deviceId, session);
+    const result = await client.changeAudioInputDevice(deviceId, session as any);
     expect(result).toBeTruthy();
   });
   it('should NOT change the audio input track if the provided id is the same', async () => {
-    // @ts-expect-error
-    client.setMediaConstraints(constraints);
+    client.setMediaConstraints(constraints as any);
     expect(client.getAudioDeviceId()).toBe(defaultId);
-    // @ts-expect-error
-    const result = await client.changeAudioInputDevice(defaultId, session);
+    const result = await client.changeAudioInputDevice(defaultId, session as any);
     expect(result).toBeFalsy();
   });
   it('should change the audio input track if the provided id is the same and force param is TRUE', async () => {
-    // @ts-expect-error
-    client.setMediaConstraints(constraints);
+    client.setMediaConstraints(constraints as any);
     expect(client.getAudioDeviceId()).toBe(defaultId);
-    // @ts-expect-error
-    const result = await client.changeAudioInputDevice(defaultId, session, true);
+    const result = await client.changeAudioInputDevice(defaultId, session as any, true);
     expect(result).toBeTruthy();
   });
   describe('setVideoInputDevice', () => {

src/api/auth.ts

@@ -17,8 +17,8 @@ type LoginParams = {
 };
 
 type SendResetPasswordArgs = {
-  username: string,
-  email: string,
+  username?: string,
+  email?: string,
 };
 
 export interface AuthD {
@@ -166,9 +166,6 @@ export default ((client: ApiRequester, baseUrl: string): AuthD => ({
   sendResetPasswordEmail: ({
     username,
     email,
-  }: {
-    username: string | null | undefined;
-    email: string | null | undefined;
   }) => {
     const body: any = {};
 

src/api/call-logd.ts

@@ -2,10 +2,10 @@ import ApiRequester from '../utils/api-requester';
 import CallLog from '../domain/CallLog';
 
 export interface CallLogD {
-  search: (search: string, limit: number) => Promise<Array<CallLog>>;
-  searchBy: (field: string, value: string, limit: number) => Promise<Array<CallLog>>;
+  search: (search: string, limit?: number) => Promise<Array<CallLog>>;
+  searchBy: (field: string, value: string, limit?: number) => Promise<Array<CallLog>>;
   listCallLogs: (offset?: number, limit?: number) => Promise<Array<CallLog>>;
-  listDistinctCallLogs: (offset: number, limit: number, distinct?: string) => Promise<Array<CallLog>>;
+  listDistinctCallLogs: (offset: number, limit?: number, distinct?: string) => Promise<Array<CallLog>>;
   listCallLogsFromDate: (from: Date, number: string) => Promise<Array<CallLog>>;
 }
 

src/api/chatd.ts

@@ -1,35 +1,22 @@
 import ApiRequester from '../utils/api-requester';
-import type { UUID } from '../domain/types';
+import type { PresenceResponse, UUID } from '../domain/types';
 import Profile from '../domain/Profile';
 import ChatRoom from '../domain/ChatRoom';
 import type { ChatUser, ChatMessageListResponse } from '../domain/ChatMessage';
 import ChatMessage from '../domain/ChatMessage';
 
-export type PresenceResponse = {
-  lines: Array<{
-    id: number;
-    state: string;
-  }>;
-  sessions: Array<{
-    mobile: boolean;
-    uuid: string;
-  }>;
-  state: string;
-  status: string;
-  user_uuid: string;
-};
 type PresenceListResponse = {
   filtered: number;
   total: number;
   items: Array<PresenceResponse>;
 };
 type GetMessagesOptions = {
-  direction: string | null | undefined;
-  limit: number | null | undefined;
-  order: string | null | undefined;
-  offset: string | null | undefined;
-  search: string | null | undefined;
-  distinct: string | null | undefined;
+  direction?: string;
+  limit?: number;
+  order?: string;
+  offset?: string;
+  search?: string;
+  distinct?: string;
 };
 
 export interface ChatD {
@@ -43,7 +30,7 @@ export interface ChatD {
   createRoom: (name: string, users: Array<ChatUser>) => Promise<ChatRoom>;
   getRoomMessages: (roomUuid: string, params?: GetMessagesOptions) => Promise<Array<ChatMessage>>;
   sendRoomMessage: (roomUuid: string, message: ChatMessage) => Promise<ChatMessage>;
-  getMessages: (options: GetMessagesOptions) => Promise<ChatMessage>;
+  getMessages: (options: GetMessagesOptions) => Promise<ChatMessageListResponse>;
 }
 
 // split contact status retrieval to avoid `414 Request-URI Too Large`.
@@ -68,9 +55,8 @@ export default ((client: ApiRequester, baseUrl: string): ChatD => ({
     const uuids: Array<UUID> = contactUuids || [];
 
     if (uuids.length > MAX_PRESENCE_FETCHED) {
-      const requests = uuids.reduce((acc, _, i) => {
+      const requests = uuids.reduce((acc: Promise<PresenceResponse[]>[], _, i) => {
         if (i % MAX_PRESENCE_FETCHED === 0) {
-          // @ts-ignore
           acc.push(this.getMultipleLineState(uuids.slice(i, i + MAX_PRESENCE_FETCHED)));
         }
         return acc;
@@ -97,5 +83,5 @@ export default ((client: ApiRequester, baseUrl: string): ChatD => ({
     return client.get(`${baseUrl}/users/me/rooms/${roomUuid}/messages${qs.length ? `?${qs}` : ''}`).then((response: ChatMessageListResponse) => ChatMessage.parseMany(response));
   },
   sendRoomMessage: async (roomUuid: string, message: ChatMessage): Promise<ChatMessage> => client.post(`${baseUrl}/users/me/rooms/${roomUuid}/messages`, message).then(ChatMessage.parse),
-  getMessages: async (options: GetMessagesOptions): Promise<ChatMessage> => client.get(`${baseUrl}/users/me/rooms/messages`, options),
+  getMessages: async (options: GetMessagesOptions): Promise<ChatMessageListResponse> => client.get(`${baseUrl}/users/me/rooms/messages`, options),
 }));