[Communication] - Linter - Fixing some linter warnings in the common package (Azure#13874)

* [Lint] fixing warnings

* [Lint] fixing warnings

* [Linter] fixing the types as per PR feedback

Author: JoshuaLai

sdk/communication/communication-common/review/communication-common.api.md

@@ -69,7 +69,7 @@ export const getIdentifierKind: (identifier: CommunicationIdentifier) => Communi
 export const isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier;
 
 // @public
-export const isKeyCredential: (credential: any) => credential is KeyCredential;
+export const isKeyCredential: (credential: unknown) => credential is KeyCredential;
 
 // @public
 export const isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier;
@@ -93,7 +93,7 @@ export interface MicrosoftTeamsUserKind extends MicrosoftTeamsUserIdentifier {
 }
 
 // @public
-export const parseClientArguments: (connectionStringOrUrl: string, credentialOrOptions?: any) => UrlWithCredential;
+export const parseClientArguments: (connectionStringOrUrl: string, credentialOrOptions?: unknown) => UrlWithCredential;
 
 // @public
 export const parseConnectionString: (connectionString: string) => EndpointCredential;

sdk/communication/communication-common/src/credential/clientArguments.ts

@@ -27,8 +27,16 @@ const assertValidEndpoint = (host: string): void => {
  *
  * @param credential - The credential being checked.
  */
-export const isKeyCredential = (credential: any): credential is KeyCredential => {
-  return credential && typeof credential.key === "string" && credential.getToken === undefined;
+export const isKeyCredential = (credential: unknown): credential is KeyCredential => {
+  const castCredential = credential as {
+    key: unknown;
+    getToken: unknown;
+  };
+  return (
+    castCredential &&
+    typeof castCredential.key === "string" &&
+    castCredential.getToken === undefined
+  );
 };
 
 /**
@@ -44,7 +52,7 @@ export type UrlWithCredential = {
  */
 export const parseClientArguments = (
   connectionStringOrUrl: string,
-  credentialOrOptions?: any
+  credentialOrOptions?: unknown
 ): UrlWithCredential => {
   if (isKeyCredential(credentialOrOptions) || isTokenCredential(credentialOrOptions)) {
     assertValidEndpoint(connectionStringOrUrl);

sdk/communication/communication-common/src/identifierModelSerializer.ts

@@ -77,6 +77,37 @@ export interface _SerializedMicrosoftTeamsUserIdentifier {
  */
 export type _SerializedCommunicationCloudEnvironment = "public" | "dod" | "gcch";
 
+const addRawIdIfExisting = <T>(
+  identifier: T,
+  rawId: string | undefined
+): T & { rawId?: string } => {
+  return rawId === undefined ? identifier : { ...identifier, rawId: rawId };
+};
+
+const assertNotNullOrUndefined = <
+  T extends Record<string, unknown>,
+  P extends keyof T,
+  Q extends keyof T[P]
+>(
+  obj: T,
+  prop: Q
+): Required<Required<T>[P]>[Q] => {
+  const subObjName = Object.keys(obj)[0];
+  const subObj = (obj as any)[subObjName];
+  if (prop in subObj) {
+    return subObj[prop];
+  }
+  throw new Error(`Property ${prop} is required for identifier of type ${subObjName}.`);
+};
+
+const assertMaximumOneNestedModel = (identifier: _SerializedCommunicationIdentifier): void => {
+  const { rawId, ...props } = identifier;
+  const keys = Object.keys(props);
+  if (keys.length > 1) {
+    throw new Error(`Only one of the properties in ${JSON.stringify(keys)} should be present.`);
+  }
+};
+
 /**
  * @internal
  * Translates a CommunicationIdentifier to its serialized format for sending a request.
@@ -150,30 +181,3 @@ export const _deserializeCommunicationIdentifier = (
     id: assertNotNullOrUndefined({ unknown: serializedIdentifier }, "rawId")
   };
 };
-
-const addRawIdIfExisting = <T>(
-  identifier: T,
-  rawId: string | undefined
-): T & { rawId?: string } => {
-  return rawId === undefined ? identifier : { ...identifier, rawId: rawId };
-};
-
-const assertNotNullOrUndefined = <T extends {}, P extends keyof T, Q extends keyof T[P]>(
-  obj: T,
-  prop: Q
-): Required<Required<T>[P]>[Q] => {
-  const subObjName = Object.keys(obj)[0];
-  const subObj = (obj as any)[subObjName];
-  if (prop in subObj) {
-    return subObj[prop];
-  }
-  throw new Error(`Property ${prop} is required for identifier of type ${subObjName}.`);
-};
-
-const assertMaximumOneNestedModel = (identifier: _SerializedCommunicationIdentifier) => {
-  const { rawId, ...props } = identifier;
-  const keys = Object.keys(props);
-  if (keys.length > 1) {
-    throw new Error(`Only one of the properties in ${JSON.stringify(keys)} should be present.`);
-  }
-};

sdk/communication/communication-common/test/identifierModelSerializer.spec.ts

@@ -31,15 +31,15 @@ const assertThrowsMissingProperty = <
   serializedIdentifier: _SerializedCommunicationIdentifier,
   identifierType: P,
   missingPropertyName: Q
-) => {
+): void => {
   assert.throws(() => {
     _deserializeCommunicationIdentifier(serializedIdentifier);
   }, `Property ${missingPropertyName} is required for identifier of type ${identifierType}.`);
 };
 
 const assertThrowsTooManyProperties = (
   serializedIdentifier: _SerializedCommunicationIdentifier
-) => {
+): void => {
   const { rawId, ...props } = serializedIdentifier;
   assert.throws(() => {
     _deserializeCommunicationIdentifier(serializedIdentifier);