Rename MSTeams to MsTeams

.changeset/khaki-ways-protect.md

@@ -4,4 +4,4 @@
 "@knocklabs/react": minor
 ---
 
-feat: add MSTeamsAuthButton
+feat: add MsTeamsAuthButton

packages/client/src/clients/ms-teams/index.ts

@@ -3,7 +3,7 @@ import { AuthCheckInput, RevokeAccessTokenInput } from "../../interfaces";
 import Knock from "../../knock";
 import { TENANT_OBJECT_COLLECTION } from "../objects/constants";
 
-class MSTeamsClient {
+class MsTeamsClient {
   private instance: Knock;
 
   constructor(instance: Knock) {
@@ -57,4 +57,4 @@ class MSTeamsClient {
   }
 }
 
-export default MSTeamsClient;
+export default MsTeamsClient;

packages/client/src/knock.ts

@@ -3,7 +3,7 @@ import { jwtDecode } from "jwt-decode";
 import ApiClient from "./api";
 import FeedClient from "./clients/feed";
 import MessageClient from "./clients/messages";
-import MSTeamsClient from "./clients/ms-teams";
+import MsTeamsClient from "./clients/ms-teams";
 import ObjectClient from "./clients/objects";
 import Preferences from "./clients/preferences";
 import SlackClient from "./clients/slack";
@@ -28,7 +28,7 @@ class Knock {
   readonly objects = new ObjectClient(this);
   readonly preferences = new Preferences(this);
   readonly slack = new SlackClient(this);
-  readonly msTeams = new MSTeamsClient(this);
+  readonly msTeams = new MsTeamsClient(this);
   readonly user = new UserClient(this);
   readonly messages = new MessageClient(this);
 

packages/react-core/src/modules/core/utils.ts

@@ -76,21 +76,21 @@ export function slackProviderKey({
 }
 
 /*
-  Used to build a consistent key for the KnockMSTeamsProvider so that React knows when
+  Used to build a consistent key for the KnockMsTeamsProvider so that React knows when
   to trigger a re-render of the context when a key property changes.
 */
 export function msTeamsProviderKey({
-  knockMSTeamsChannelId,
+  knockMsTeamsChannelId,
   tenantId,
   connectionStatus,
   errorLabel,
 }: {
-  knockMSTeamsChannelId: string;
+  knockMsTeamsChannelId: string;
   tenantId: string;
   connectionStatus: string;
   errorLabel: string | null;
 }) {
-  return [knockMSTeamsChannelId, tenantId, connectionStatus, errorLabel]
+  return [knockMsTeamsChannelId, tenantId, connectionStatus, errorLabel]
     .filter((f) => f !== null && f !== undefined)
     .join("-");
 }

packages/react-core/src/modules/ms-teams/context/KnockMSTeamsProvider.tsx → packages/react-core/src/modules/ms-teams/context/KnockMsTeamsProvider.tsx

@@ -3,11 +3,11 @@ import { PropsWithChildren } from "react";
 
 import { useKnockClient } from "../../core";
 import { msTeamsProviderKey } from "../../core/utils";
-import { useMSTeamsConnectionStatus } from "../hooks";
-import { ConnectionStatus } from "../hooks/useMSTeamsConnectionStatus";
+import { useMsTeamsConnectionStatus } from "../hooks";
+import { ConnectionStatus } from "../hooks/useMsTeamsConnectionStatus";
 
-export interface KnockMSTeamsProviderState {
-  knockMSTeamsChannelId: string;
+export interface KnockMsTeamsProviderState {
+  knockMsTeamsChannelId: string;
   tenantId: string;
   connectionStatus: ConnectionStatus;
   setConnectionStatus: (connectionStatus: ConnectionStatus) => void;
@@ -17,17 +17,17 @@ export interface KnockMSTeamsProviderState {
   setActionLabel: (label: string | null) => void;
 }
 
-const MSTeamsProviderStateContext =
-  React.createContext<KnockMSTeamsProviderState | null>(null);
+const MsTeamsProviderStateContext =
+  React.createContext<KnockMsTeamsProviderState | null>(null);
 
-export interface KnockMSTeamsProviderProps {
-  knockMSTeamsChannelId: string;
+export interface KnockMsTeamsProviderProps {
+  knockMsTeamsChannelId: string;
   tenantId: string;
 }
 
-export const KnockMSTeamsProvider: React.FC<
-  PropsWithChildren<KnockMSTeamsProviderProps>
-> = ({ knockMSTeamsChannelId, tenantId, children }) => {
+export const KnockMsTeamsProvider: React.FC<
+  PropsWithChildren<KnockMsTeamsProviderProps>
+> = ({ knockMsTeamsChannelId, tenantId, children }) => {
   const knock = useKnockClient();
 
   const {
@@ -37,12 +37,12 @@ export const KnockMSTeamsProvider: React.FC<
     setErrorLabel,
     actionLabel,
     setActionLabel,
-  } = useMSTeamsConnectionStatus(knock, knockMSTeamsChannelId, tenantId);
+  } = useMsTeamsConnectionStatus(knock, knockMsTeamsChannelId, tenantId);
 
   return (
-    <MSTeamsProviderStateContext.Provider
+    <MsTeamsProviderStateContext.Provider
       key={msTeamsProviderKey({
-        knockMSTeamsChannelId,
+        knockMsTeamsChannelId,
         tenantId,
         connectionStatus,
         errorLabel,
@@ -54,20 +54,20 @@ export const KnockMSTeamsProvider: React.FC<
         setErrorLabel,
         actionLabel,
         setActionLabel,
-        knockMSTeamsChannelId,
+        knockMsTeamsChannelId,
         tenantId,
       }}
     >
       {children}
-    </MSTeamsProviderStateContext.Provider>
+    </MsTeamsProviderStateContext.Provider>
   );
 };
 
-export const useKnockMSTeamsClient = (): KnockMSTeamsProviderState => {
-  const context = React.useContext(MSTeamsProviderStateContext);
+export const useKnockMsTeamsClient = (): KnockMsTeamsProviderState => {
+  const context = React.useContext(MsTeamsProviderStateContext);
   if (!context) {
     throw new Error(
-      "useKnockMSTeamsClient must be used within a KnockMSTeamsProvider",
+      "useKnockMsTeamsClient must be used within a KnockMsTeamsProvider",
     );
   }
   return context;

packages/react-core/src/modules/ms-teams/context/index.ts

@@ -1 +1 @@
-export * from "./KnockMSTeamsProvider";
+export * from "./KnockMsTeamsProvider";

packages/react-core/src/modules/ms-teams/hooks/index.ts

@@ -1,2 +1,2 @@
-export { default as useMSTeamsConnectionStatus } from "./useMSTeamsConnectionStatus";
-export { default as useMSTeamsAuth } from "./useMSTeamsAuth";
+export { default as useMsTeamsConnectionStatus } from "./useMsTeamsConnectionStatus";
+export { default as useMsTeamsAuth } from "./useMsTeamsAuth";

packages/react-core/src/modules/ms-teams/hooks/useMSTeamsAuth.ts → packages/react-core/src/modules/ms-teams/hooks/useMsTeamsAuth.ts

@@ -1,4 +1,4 @@
-import { useKnockMSTeamsClient } from "..";
+import { useKnockMsTeamsClient } from "..";
 import { TENANT_OBJECT_COLLECTION } from "@knocklabs/client";
 import { useCallback, useMemo } from "react";
 
@@ -9,37 +9,37 @@ const MS_TEAMS_ADMINCONSENT_URL =
 
 const AUTH_REDIRECT_PATH = "/providers/ms-teams/authenticate";
 
-interface UseMSTeamsAuthOutput {
-  buildMSTeamsAuthUrl: () => string;
-  disconnectFromMSTeams: () => void;
+interface UseMsTeamsAuthOutput {
+  buildMsTeamsAuthUrl: () => string;
+  disconnectFromMsTeams: () => void;
 }
 
-function useMSTeamsAuth(
+function useMsTeamsAuth(
   msTeamsBotId: string,
   redirectUrl?: string,
-): UseMSTeamsAuthOutput {
+): UseMsTeamsAuthOutput {
   const knock = useKnockClient();
   const {
     setConnectionStatus,
-    knockMSTeamsChannelId,
+    knockMsTeamsChannelId,
     tenantId,
     setActionLabel,
-  } = useKnockMSTeamsClient();
+  } = useKnockMsTeamsClient();
 
   const authRedirectUri = useMemo(
     () => knock.host + AUTH_REDIRECT_PATH,
     [knock.host],
   );
 
-  const buildMSTeamsAuthUrl = useCallback(() => {
+  const buildMsTeamsAuthUrl = useCallback(() => {
     const rawParams = {
       state: JSON.stringify({
         redirect_url: redirectUrl,
         ms_teams_tenant_object: {
           object_id: tenantId,
           collection: TENANT_OBJECT_COLLECTION,
         },
-        channel_id: knockMSTeamsChannelId,
+        channel_id: knockMsTeamsChannelId,
         public_key: knock.apiKey,
         user_token: knock.userToken,
       }),
@@ -50,20 +50,20 @@ function useMSTeamsAuth(
   }, [
     redirectUrl,
     tenantId,
-    knockMSTeamsChannelId,
+    knockMsTeamsChannelId,
     knock.apiKey,
     knock.userToken,
     msTeamsBotId,
     authRedirectUri,
   ]);
 
-  const disconnectFromMSTeams = useCallback(async () => {
+  const disconnectFromMsTeams = useCallback(async () => {
     setActionLabel(null);
     setConnectionStatus("disconnecting");
     try {
       const revokeResult = await knock.msTeams.revokeAccessToken({
         tenant: tenantId,
-        knockChannelId: knockMSTeamsChannelId,
+        knockChannelId: knockMsTeamsChannelId,
       });
 
       setConnectionStatus(revokeResult === "ok" ? "disconnected" : "error");
@@ -74,11 +74,11 @@ function useMSTeamsAuth(
     setConnectionStatus,
     knock.msTeams,
     tenantId,
-    knockMSTeamsChannelId,
+    knockMsTeamsChannelId,
     setActionLabel,
   ]);
 
-  return { buildMSTeamsAuthUrl, disconnectFromMSTeams };
+  return { buildMsTeamsAuthUrl, disconnectFromMsTeams };
 }
 
-export default useMSTeamsAuth;
+export default useMsTeamsAuth;

packages/react-core/src/modules/ms-teams/hooks/useMSTeamsConnectionStatus.ts → packages/react-core/src/modules/ms-teams/hooks/useMsTeamsConnectionStatus.ts

@@ -10,7 +10,7 @@ export type ConnectionStatus =
   | "error"
   | "disconnecting";
 
-type UseMSTeamsConnectionStatusOutput = {
+type UseMsTeamsConnectionStatusOutput = {
   connectionStatus: ConnectionStatus;
   setConnectionStatus: (status: ConnectionStatus) => void;
   errorLabel: string | null;
@@ -19,11 +19,11 @@ type UseMSTeamsConnectionStatusOutput = {
   setActionLabel: (actionLabel: string | null) => void;
 };
 
-function useMSTeamsConnectionStatus(
+function useMsTeamsConnectionStatus(
   knock: Knock,
-  knockMSTeamsChannelId: string,
+  knockMsTeamsChannelId: string,
   tenantId: string,
-): UseMSTeamsConnectionStatusOutput {
+): UseMsTeamsConnectionStatusOutput {
   const { t } = useTranslations();
 
   const [connectionStatus, setConnectionStatus] =
@@ -38,7 +38,7 @@ function useMSTeamsConnectionStatus(
       try {
         const authRes = await knock.msTeams.authCheck({
           tenant: tenantId,
-          knockChannelId: knockMSTeamsChannelId,
+          knockChannelId: knockMsTeamsChannelId,
         });
 
         if (authRes.connection?.ok === true) {
@@ -67,7 +67,7 @@ function useMSTeamsConnectionStatus(
     };
 
     checkAuthStatus();
-  }, [connectionStatus, tenantId, knockMSTeamsChannelId, knock.msTeams, t]);
+  }, [connectionStatus, tenantId, knockMsTeamsChannelId, knock.msTeams, t]);
 
   return {
     connectionStatus,
@@ -79,4 +79,4 @@ function useMSTeamsConnectionStatus(
   };
 }
 
-export default useMSTeamsConnectionStatus;
+export default useMsTeamsConnectionStatus;

packages/react/src/modules/ms-teams/components/MSTeamsAuthButton/MSTeamsAuthButton.tsx → packages/react/src/modules/ms-teams/components/MsTeamsAuthButton/MsTeamsAuthButton.tsx

@@ -1,24 +1,24 @@
 import {
   useKnockClient,
-  useKnockMSTeamsClient,
-  useMSTeamsAuth,
+  useKnockMsTeamsClient,
+  useMsTeamsAuth,
   useTranslations,
 } from "@knocklabs/react-core";
 import { FunctionComponent, useEffect } from "react";
 
 import { openPopupWindow } from "../../../core/utils";
 import "../../theme.css";
-import { MSTeamsIcon } from "../MSTeamsIcon";
+import { MsTeamsIcon } from "../MsTeamsIcon";
 
 import "./styles.css";
 
-export interface MSTeamsAuthButtonProps {
+export interface MsTeamsAuthButtonProps {
   msTeamsBotId: string;
   redirectUrl?: string;
   onAuthenticationComplete?: (authenticationResp: string) => void;
 }
 
-export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
+export const MsTeamsAuthButton: FunctionComponent<MsTeamsAuthButtonProps> = ({
   msTeamsBotId,
   redirectUrl,
   onAuthenticationComplete,
@@ -32,9 +32,9 @@ export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
     setActionLabel,
     actionLabel,
     errorLabel,
-  } = useKnockMSTeamsClient();
+  } = useKnockMsTeamsClient();
 
-  const { buildMSTeamsAuthUrl, disconnectFromMSTeams } = useMSTeamsAuth(
+  const { buildMsTeamsAuthUrl, disconnectFromMsTeams } = useMsTeamsAuth(
     msTeamsBotId,
     redirectUrl,
   );
@@ -78,7 +78,7 @@ export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
   ) {
     return (
       <div className="rtk-connect__button rtk-connect__button--loading">
-        <MSTeamsIcon height="16px" width="16px" />
+        <MsTeamsIcon height="16px" width="16px" />
         <span>
           {connectionStatus === "connecting"
             ? t("msTeamsConnecting")
@@ -92,12 +92,12 @@ export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
   if (connectionStatus === "error") {
     return (
       <button
-        onClick={() => openPopupWindow(buildMSTeamsAuthUrl())}
+        onClick={() => openPopupWindow(buildMsTeamsAuthUrl())}
         className="rtk-connect__button rtk-connect__button--error"
         onMouseEnter={() => setActionLabel(reconnectLabel)}
         onMouseLeave={() => setActionLabel(null)}
       >
-        <MSTeamsIcon height="16px" width="16px" />
+        <MsTeamsIcon height="16px" width="16px" />
         <span className="rtk-connect__button__text--error">
           {actionLabel || errorLabel || t("msTeamsError")}
         </span>
@@ -109,10 +109,10 @@ export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
   if (connectionStatus === "disconnected") {
     return (
       <button
-        onClick={() => openPopupWindow(buildMSTeamsAuthUrl())}
+        onClick={() => openPopupWindow(buildMsTeamsAuthUrl())}
         className="rtk-connect__button rtk-connect__button--disconnected"
       >
-        <MSTeamsIcon height="16px" width="16px" />
+        <MsTeamsIcon height="16px" width="16px" />
         <span>{t("msTeamsConnect")}</span>
       </button>
     );
@@ -121,12 +121,12 @@ export const MSTeamsAuthButton: FunctionComponent<MSTeamsAuthButtonProps> = ({
   // Connected state
   return (
     <button
-      onClick={disconnectFromMSTeams}
+      onClick={disconnectFromMsTeams}
       className="rtk-connect__button rtk-connect__button--connected"
       onMouseEnter={() => setActionLabel(disconnectLabel)}
       onMouseLeave={() => setActionLabel(null)}
     >
-      <MSTeamsIcon height="16px" width="16px" />
+      <MsTeamsIcon height="16px" width="16px" />
       <span className="rtk-connect__button__text--connected">
         {actionLabel || t("msTeamsConnected")}
       </span>

packages/react/src/modules/ms-teams/components/MsTeamsAuthButton/index.ts

@@ -0,0 +1 @@
+export * from "./MsTeamsAuthButton";