@atlaskit/teams-client 5.2.0 → 5.3.0

package/dist/es2019/services/sentry/utils/sentry-client.js

@@ -1,58 +0,0 @@
-import { SENTRY_DSN } from '../constants';
-import { initialiseSentry } from './initialise-sentry';
-export let sentryClient;
-export const setSentryClient = client => {
-  sentryClient = client;
-};
-export const getSentryClient = async () => {
-  if (!sentryClient) {
-    await setupSentryClient({});
-  }
-  return sentryClient;
-};
-export async function setupSentryClient({
-  appName,
-  env
-}) {
-  var _window$__buildInfo;
-  const sentryClient = await requireSentryLib();
-  if (!sentryClient) {
-    return;
-  }
-
-  // initialiseSentry sets the sentry client
-  initialiseSentry(sentryClient, {
-    initialScope: {
-      tags: {
-        renderMode: appName || 'unknown',
-        productBuild:
-        // @ts-ignore Jira  - window.BUILD_KEY, confluence - window.__buildInfo
-        window.BUILD_KEY || ((_window$__buildInfo = window.__buildInfo) === null || _window$__buildInfo === void 0 ? void 0 : _window$__buildInfo.FRONTEND_VERSION) || 'unknown',
-        product: getProduct()
-      }
-    },
-    env,
-    noGlobals: true,
-    dsn: SENTRY_DSN,
-    attachStacktrace: true
-  });
-}
-async function requireSentryLib() {
-  // saving ~40K
-  try {
-    return import( /* webpackChunkName: "teams-client_sentry" */'@sentry/browser');
-  } catch (error) {
-    // eslint-disable-next-line no-console
-    console.warn('Ignoring rejected promise when loading sentry resource.', error);
-    return undefined;
-  }
-}
-function getProduct() {
-  const path = window.location.pathname;
-  if (path.includes('/jira/people')) {
-    return 'jira';
-  } else if (path.includes('/wiki/people')) {
-    return 'confluence';
-  }
-  return 'unknown';
-}

package/dist/es2019/services/sentry/utils/set-sentry-client.js

@@ -0,0 +1,4 @@
+import { sentryClientRef } from './sentry-client-ref';
+export const setSentryClient = client => {
+  sentryClientRef.current = client;
+};

package/dist/es2019/services/sentry/utils/setup-sentry-client.js

@@ -0,0 +1,48 @@
+import { SENTRY_DSN } from '../constants';
+import { initialiseSentry } from './initialise-sentry';
+async function requireSentryLib() {
+  // saving ~40K
+  try {
+    return import( /* webpackChunkName: "teams-client_sentry" */'@sentry/browser');
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.warn('Ignoring rejected promise when loading sentry resource.', error);
+    return undefined;
+  }
+}
+function getProduct() {
+  const path = window.location.pathname;
+  if (path.includes('/jira/people')) {
+    return 'jira';
+  } else if (path.includes('/wiki/people')) {
+    return 'confluence';
+  }
+  return 'unknown';
+}
+export async function setupSentryClient({
+  appName,
+  env
+}) {
+  var _window$__buildInfo;
+  const sentryClient = await requireSentryLib();
+  if (!sentryClient) {
+    return;
+  }
+
+  // initialiseSentry sets the sentry client
+  initialiseSentry(sentryClient, {
+    initialScope: {
+      tags: {
+        renderMode: appName || 'unknown',
+        productBuild:
+        // @ts-ignore Jira  - window.BUILD_KEY, confluence - window.__buildInfo
+        window.BUILD_KEY || ((_window$__buildInfo = window.__buildInfo) === null || _window$__buildInfo === void 0 ? void 0 : _window$__buildInfo.FRONTEND_VERSION) || 'unknown',
+        product: getProduct()
+      }
+    },
+    env,
+    noGlobals: true,
+    dsn: SENTRY_DSN,
+    attachStacktrace: true
+  });
+}

package/dist/es2019/services/sentry/utils/use-teams-sentry-client-setup.js

@@ -1,14 +1,15 @@
 import { useCallback, useEffect, useState } from 'react';
-import { sentryClient, setupSentryClient } from './sentry-client';
+import { sentryClientRef } from './sentry-client-ref';
+import { setupSentryClient } from './setup-sentry-client';
 export const useTeamsSentryClientSetup = (isSentryEnabled, config) => {
   const [sentryInitialised, setSentryInitialised] = useState(false);
   const setupSentry = useCallback(async () => {
-    if (!sentryInitialised && isSentryEnabled && !sentryClient) {
+    if (!sentryInitialised && isSentryEnabled && !sentryClientRef.current) {
       await setupSentryClient(config);
     }
   }, [config, isSentryEnabled, sentryInitialised]);
   useEffect(() => {
     setupSentry().then(() => setSentryInitialised(true));
   }, [setupSentry]);
-  return sentryClient;
+  return sentryClientRef.current;
 };

package/dist/es2019/services/team-central-client/TeamCentralClient.js

@@ -0,0 +1,115 @@
+import { BaseGraphQlClient } from '../graphql-client/main';
+import { getTeamCentralGraphqlUrl } from './getTeamCentralGraphqlUrl';
+import { getUnshardedTeamCentralGraphqlUrl } from './getUnshardedTeamCentralGraphqlUrl';
+import { AddTeamWatcherMutation } from './mutations/add-team-watcher.graphql';
+import { CreateTagMutation } from './mutations/create-tag-mutation.graphql';
+import { HelpPointerCreateMutation } from './mutations/help-pointer-create-mutation.graphql';
+import { HelpPointerDeleteMutation } from './mutations/help-pointer-delete-mutation.graphql';
+import { HelpPointerUpdateMutation } from './mutations/help-pointer-update-mutation.graphql';
+import { KudosDeleteMutation } from './mutations/kudos-delete-mutation.graphql';
+import { RemoveTeamWatcherMutation } from './mutations/remove-team-watcher.graphql';
+import { IsTeamWatcherQuery } from './queries/is-team-watcher.graphql';
+import { TagListQuery } from './queries/tag-list-query.graphql';
+export class TeamCentralClient extends BaseGraphQlClient {
+  constructor(baseUrl, config) {
+    super(getUnshardedTeamCentralGraphqlUrl(baseUrl), config);
+  }
+
+  // Team central url is a bit special, that it depends on cloudId.
+  setBaseUrl(baseUrl) {
+    const cloudId = this.getCloudId();
+    this.setServiceUrl(cloudId && cloudId !== 'None' ? getTeamCentralGraphqlUrl(baseUrl, cloudId) : getUnshardedTeamCentralGraphqlUrl(baseUrl));
+  }
+  async isTeamWatcher(teamId, cloudId) {
+    const response = await this.makeGraphQLRequest({
+      query: IsTeamWatcherQuery,
+      variables: {
+        teamId: teamId.replace('ari:cloud:identity::team/', ''),
+        cloudId: cloudId || 'None'
+      }
+    }, {
+      operationName: 'isTeamWatcher'
+    });
+    return response.isTeamWatcher;
+  }
+  async addTeamWatcher(teamId, cloudId) {
+    const response = await this.makeGraphQLRequest({
+      query: AddTeamWatcherMutation,
+      variables: {
+        teamId,
+        cloudId
+      }
+    }, {
+      operationName: 'addTeamWatcher'
+    });
+    return response.addTeamWatcher;
+  }
+  async removeTeamWatcher(teamId, cloudId) {
+    const response = await this.makeGraphQLRequest({
+      query: RemoveTeamWatcherMutation,
+      variables: {
+        teamId,
+        cloudId
+      }
+    }, {
+      operationName: 'removeTeamWatcher'
+    });
+    return response.removeTeamWatcher;
+  }
+  async deleteKudos(id) {
+    const response = await this.makeGraphQLRequest({
+      query: KudosDeleteMutation,
+      variables: {
+        id
+      }
+    }, {
+      operationName: 'DeleteKudos'
+    });
+    return response.deleteKudos;
+  }
+  async queryTagList(variables) {
+    const response = await this.makeGraphQLRequest({
+      query: TagListQuery,
+      variables
+    }, {
+      operationName: 'TagListByCloudId'
+    });
+    return response.tagSearchByCloudId;
+  }
+  async createTag(variables) {
+    const response = await this.makeGraphQLRequest({
+      query: CreateTagMutation,
+      variables
+    }, {
+      operationName: 'createTagForCloudId'
+    });
+    return response.createTagForCloudId;
+  }
+  async createHelpPointer(variables) {
+    const response = await this.makeGraphQLRequest({
+      query: HelpPointerCreateMutation,
+      variables
+    }, {
+      operationName: 'CreateHelpPointer'
+    });
+    return response.createHelpPointer;
+  }
+  async updateHelpPointer(variables) {
+    const response = await this.makeGraphQLRequest({
+      query: HelpPointerUpdateMutation,
+      variables
+    }, {
+      operationName: 'UpdateHelpPointer'
+    });
+    return response.updateHelpPointer;
+  }
+  async deleteHelpPointer(variables) {
+    const response = await this.makeGraphQLRequest({
+      query: HelpPointerDeleteMutation,
+      variables
+    }, {
+      operationName: 'DeleteHelpPointer'
+    });
+    return response.deleteHelpPointer;
+  }
+}

package/dist/es2019/services/team-central-client/getTeamCentralGraphqlUrl.js

@@ -0,0 +1 @@
+export const getTeamCentralGraphqlUrl = (baseUrl, cloudId) => `${baseUrl}/townsquare/s/${cloudId}/graphql`;

package/dist/es2019/services/team-central-client/getUnshardedTeamCentralGraphqlUrl.js

@@ -0,0 +1 @@
+export const getUnshardedTeamCentralGraphqlUrl = baseUrl => `${baseUrl}/watermelon/graphql`;

package/dist/es2019/services/team-central-client/index.js

@@ -1,119 +1,6 @@
 import { DEFAULT_CONFIG } from '../constants';
-import { BaseGraphQlClient } from '../graphql-client';
-import { logException } from '../sentry/main';
-import { AddTeamWatcherMutation } from './mutations/add-team-watcher.graphql';
-import { CreateTagMutation } from './mutations/create-tag-mutation.graphql';
-import { HelpPointerCreateMutation } from './mutations/help-pointer-create-mutation.graphql';
-import { HelpPointerDeleteMutation } from './mutations/help-pointer-delete-mutation.graphql';
-import { HelpPointerUpdateMutation } from './mutations/help-pointer-update-mutation.graphql';
-import { KudosDeleteMutation } from './mutations/kudos-delete-mutation.graphql';
-import { RemoveTeamWatcherMutation } from './mutations/remove-team-watcher.graphql';
-import { IsTeamWatcherQuery } from './queries/is-team-watcher.graphql';
-import { TagListQuery } from './queries/tag-list-query.graphql';
-import { getTeamCentralGraphqlUrl, getUnshardedTeamCentralGraphqlUrl } from './utils';
-export class TeamCentralClient extends BaseGraphQlClient {
-  constructor(baseUrl, config) {
-    super(getUnshardedTeamCentralGraphqlUrl(baseUrl), config);
-  }
-
-  // Team central url is a bit special, that it depends on cloudId.
-  setBaseUrl(baseUrl) {
-    const cloudId = this.getCloudId();
-    this.setServiceUrl(cloudId && cloudId !== 'None' ? getTeamCentralGraphqlUrl(baseUrl, cloudId) : getUnshardedTeamCentralGraphqlUrl(baseUrl));
-  }
-  async isTeamWatcher(teamId, cloudId) {
-    const response = await this.makeGraphQLRequest({
-      query: IsTeamWatcherQuery,
-      variables: {
-        teamId: teamId.replace('ari:cloud:identity::team/', ''),
-        cloudId: cloudId || 'None'
-      }
-    }, {
-      operationName: 'isTeamWatcher'
-    });
-    return response.isTeamWatcher;
-  }
-  async addTeamWatcher(teamId, cloudId) {
-    const response = await this.makeGraphQLRequest({
-      query: AddTeamWatcherMutation,
-      variables: {
-        teamId,
-        cloudId
-      }
-    }, {
-      operationName: 'addTeamWatcher'
-    });
-    return response.addTeamWatcher;
-  }
-  async removeTeamWatcher(teamId, cloudId) {
-    const response = await this.makeGraphQLRequest({
-      query: RemoveTeamWatcherMutation,
-      variables: {
-        teamId,
-        cloudId
-      }
-    }, {
-      operationName: 'removeTeamWatcher'
-    });
-    return response.removeTeamWatcher;
-  }
-  async deleteKudos(id) {
-    const response = await this.makeGraphQLRequest({
-      query: KudosDeleteMutation,
-      variables: {
-        id
-      }
-    }, {
-      operationName: 'DeleteKudos'
-    });
-    return response.deleteKudos;
-  }
-  async queryTagList(variables) {
-    const response = await this.makeGraphQLRequest({
-      query: TagListQuery,
-      variables
-    }, {
-      operationName: 'TagListByCloudId'
-    });
-    return response.tagSearchByCloudId;
-  }
-  async createTag(variables) {
-    const response = await this.makeGraphQLRequest({
-      query: CreateTagMutation,
-      variables
-    }, {
-      operationName: 'createTagForCloudId'
-    });
-    return response.createTagForCloudId;
-  }
-  async createHelpPointer(variables) {
-    const response = await this.makeGraphQLRequest({
-      query: HelpPointerCreateMutation,
-      variables
-    }, {
-      operationName: 'CreateHelpPointer'
-    });
-    return response.createHelpPointer;
-  }
-  async updateHelpPointer(variables) {
-    const response = await this.makeGraphQLRequest({
-      query: HelpPointerUpdateMutation,
-      variables
-    }, {
-      operationName: 'UpdateHelpPointer'
-    });
-    return response.updateHelpPointer;
-  }
-  async deleteHelpPointer(variables) {
-    const response = await this.makeGraphQLRequest({
-      query: HelpPointerDeleteMutation,
-      variables
-    }, {
-      operationName: 'DeleteHelpPointer'
-    });
-    return response.deleteHelpPointer;
-  }
-}
+import { logException } from '../sentry/logException';
+import { TeamCentralClient } from './TeamCentralClient';
 const _default_1 = new TeamCentralClient(DEFAULT_CONFIG.stargateRoot, {
   logException
 });

package/dist/es2019/services/teams-in-slack-client/TeamsInSlackClient.js

@@ -0,0 +1,31 @@
+import { DEFAULT_CONFIG } from '../constants';
+import { RestClient } from '../rest-client';
+const defaultConfig = {
+  serviceUrl: `${DEFAULT_CONFIG.stargateRoot}/teamsslack/api/team`
+};
+export class TeamsInSlackClient extends RestClient {
+  constructor(config = {}) {
+    super({
+      ...defaultConfig,
+      ...config
+    });
+  }
+  async getTeamInSlack(teamId, teamName) {
+    return this.getResource(`/${teamId}?teamName=${encodeURIComponent(teamName)}`).then(response => ({
+      id: teamId,
+      ...response
+    }));
+  }
+  async disconnectTeamInSlack(teamId) {
+    return this.deleteResource(`/${teamId}`).then(response => ({
+      id: teamId,
+      ...response
+    }));
+  }
+  async updateTeamInSlack(teamId, channelId, usergroupHandle) {
+    return this.postResource(`/${teamId}?channel=${channelId}&groupName=${usergroupHandle}`).then(response => ({
+      id: teamId,
+      ...response
+    }));
+  }
+}

package/dist/es2019/services/teams-in-slack-client/index.js

@@ -1,33 +1,3 @@
-import { DEFAULT_CONFIG } from '../constants';
-import { RestClient } from '../rest-client';
-const defaultConfig = {
-  serviceUrl: `${DEFAULT_CONFIG.stargateRoot}/teamsslack/api/team`
-};
-export class TeamsInSlackClient extends RestClient {
-  constructor(config = {}) {
-    super({
-      ...defaultConfig,
-      ...config
-    });
-  }
-  async getTeamInSlack(teamId, teamName) {
-    return this.getResource(`/${teamId}?teamName=${encodeURIComponent(teamName)}`).then(response => ({
-      id: teamId,
-      ...response
-    }));
-  }
-  async disconnectTeamInSlack(teamId) {
-    return this.deleteResource(`/${teamId}`).then(response => ({
-      id: teamId,
-      ...response
-    }));
-  }
-  async updateTeamInSlack(teamId, channelId, usergroupHandle) {
-    return this.postResource(`/${teamId}?channel=${channelId}&groupName=${usergroupHandle}`).then(response => ({
-      id: teamId,
-      ...response
-    }));
-  }
-}
+import { TeamsInSlackClient } from './TeamsInSlackClient';
 const _default_1 = new TeamsInSlackClient();
 export default _default_1;

package/dist/es2019/services/use-query-light/ActualGraphQLError.js

@@ -0,0 +1,8 @@
+export class ActualGraphQLError extends Error {
+  // AGG standard
+
+  constructor(message) {
+    super(message);
+    this.message = message;
+  }
+}

package/dist/es2019/services/use-query-light/UseQueryLightError.js

@@ -0,0 +1,12 @@
+export class UseQueryLightError extends Error {
+  constructor(message, name, graphQLErrors, networkError, extensions, extraInfo) {
+    super(message);
+    this.graphQLErrors = graphQLErrors;
+    this.networkError = networkError;
+    this.extensions = extensions;
+    this.extraInfo = extraInfo;
+    if (name) {
+      this.name = name;
+    }
+  }
+}

package/dist/es2019/services/use-query-light/index.js

@@ -1,2 +1,21 @@
-export { useQueryLight, useLazyQueryLight } from './main';
-export { UseQueryLightError } from './types';
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import { useLazyQueryLight } from '@atlaskit/teams-client/use-query-light/use-lazy-query-light'` instead.
+ */
+export { useLazyQueryLight } from './useLazyQueryLight';
+/**
+ * @deprecated Use `import { useQueryLight } from '@atlaskit/teams-client/use-query-light/use-query-light'` instead.
+ */
+export { useQueryLight } from './useQueryLight';
+/**
+ * @deprecated Use `import type { ActualGraphQLError } from '@atlaskit/teams-client/actual-graph-ql-error'` instead.
+ */
+
+/**
+ * @deprecated Use `import type { FetchMoreArgs, QueryOptions } from '@atlaskit/teams-client/use-query-light/types'` instead.
+ */
+
+/**
+ * @deprecated Use `import { UseQueryLightError } from '@atlaskit/teams-client/use-query-light-error'` instead.
+ */
+export { UseQueryLightError } from './UseQueryLightError';

package/dist/es2019/services/use-query-light/main.js

@@ -1,162 +1,10 @@
-import { useCallback, useEffect, useRef, useState } from 'react';
-import { print } from 'graphql';
-import isEqual from 'lodash/isEqual';
-import { fetchWithExponentialBackoff } from '../../common/utils/http';
-import { logException } from '../sentry';
-import { UseQueryLightError } from './types';
-const transformError = ({
-  error,
-  graphQLErrors
-}) => {
-  const reducedGraphqlErrorMessage = graphQLErrors && graphQLErrors.reduce((acc, gqlError) => acc + (acc ? '\n' : '') + (gqlError.message ? gqlError.message : ''), '');
-  const reducedGraphqlErrorName = graphQLErrors && graphQLErrors.reduce((acc, gqlError) => acc + (acc ? '\n' : '') + (gqlError.name ? gqlError.name : ''), '');
-  return new UseQueryLightError(
-  // Network error would lead to no graphqlErrors as the query would not be fired. Hence at the front.
-  (error === null || error === void 0 ? void 0 : error.message) || reducedGraphqlErrorMessage || 'Unknown error', (error === null || error === void 0 ? void 0 : error.name) || reducedGraphqlErrorName,
-  // graphQLErrors in Apollo error is empty array when there is no error.
-  // So we follow the same to make sure error handlers are working as expected.
-  graphQLErrors || [], error);
-};
-export const useQueryLight = (query, options) => {
-  const [loading, setLoading] = useState(true);
-  const [error, setError] = useState(undefined);
-  const [data, setData] = useState(undefined);
-  const variablesRef = useRef(options.variables);
-
-  // Need this to deep compare variables to avoid infinite loops in useEffect
-  if (!isEqual(variablesRef.current, options.variables)) {
-    variablesRef.current = options.variables;
-  }
-
-  // Initial fetch, and refetch
-  const fetchData = useCallback(async () => {
-    try {
-      setLoading(true);
-      const response = await fetchWithExponentialBackoff(`${options.serviceUrl}?q=${options.operationName}`, {
-        method: 'POST',
-        headers: new Headers({
-          'Content-Type': 'application/json',
-          ...options.customHeaders
-        }),
-        credentials: 'include',
-        body: JSON.stringify({
-          query: print(query),
-          variables: {
-            ...variablesRef.current
-          }
-        })
-      });
-      const responseData = await response.json();
-      if (response.ok) {
-        if (responseData.errors) {
-          setError(transformError({
-            graphQLErrors: responseData.errors
-          }));
-        }
-        setData(responseData.data);
-        setLoading(false);
-      } else {
-        throw new Error(`Generic fetch error within useQueryLight, status ${response.status}`);
-      }
-    } catch (error) {
-      if (error instanceof Error) {
-        setError(transformError({
-          error
-        }));
-      } else {
-        setError(transformError({
-          error: new Error('Unknown error')
-        }));
-        logException(error, `useQueryLight - ${options.operationName}`);
-      }
-      setData(undefined);
-      setLoading(false);
-    }
-  }, [query, options.serviceUrl, options.operationName, options.customHeaders]);
-
-  // Fetch more
-  const fetchMore = useCallback(async ({
-    variables,
-    handleDataMerge
-  }) => {
-    try {
-      // reset errors to catch new ones
-      setError(undefined);
-      const response = await fetchWithExponentialBackoff(`${options.serviceUrl}?q=${options.operationName}`, {
-        method: 'POST',
-        headers: new Headers({
-          'Content-Type': 'application/json',
-          ...options.customHeaders
-        }),
-        credentials: 'include',
-        body: JSON.stringify({
-          query: print(query),
-          variables: {
-            ...variablesRef.current,
-            ...variables
-          }
-        })
-      });
-      const responseData = await response.json();
-      if (response.ok) {
-        if (responseData.errors) {
-          setError(transformError({
-            graphQLErrors: responseData.errors
-          }));
-        }
-        setData(prevData => handleDataMerge(prevData, responseData.data));
-      } else {
-        throw new Error(`Generic fetch error within useQueryLight, status ${response.status}`);
-      }
-    } catch (error) {
-      if (error instanceof Error) {
-        setError(transformError({
-          error
-        }));
-      } else {
-        setError(transformError({
-          error: new Error('Unknown error')
-        }));
-        logException(error, `useQueryLight fetchMore - ${options.operationName}`);
-      }
-    }
-  }, [query, options.serviceUrl, options.operationName, options.customHeaders]);
-  useEffect(() => {
-    if (!options.skip) {
-      fetchData();
-    } else {
-      setLoading(false);
-    }
-  }, [options.skip, variablesRef.current]); // eslint-disable-line react-hooks/exhaustive-deps
-
-  return {
-    loading,
-    error,
-    data,
-    refetch: fetchData,
-    fetchMore
-  };
-};
-export const useLazyQueryLight = (query, options) => {
-  const [fetchTriggered, setFetchTriggered] = useState(false);
-  const {
-    loading,
-    error,
-    data,
-    refetch,
-    fetchMore
-  } = useQueryLight(query, {
-    ...options,
-    skip: !fetchTriggered
-  });
-  const triggerFetch = useCallback(() => {
-    setFetchTriggered(true);
-  }, []);
-  return [triggerFetch, {
-    loading,
-    error,
-    data,
-    refetch,
-    fetchMore
-  }];
-};
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+
+/**
+ * @deprecated Use `import { useQueryLight } from '@atlaskit/teams-client/use-query-light/use-query-light'` instead.
+ */
+export { useQueryLight } from './useQueryLight';
+/**
+ * @deprecated Use `import { useLazyQueryLight } from '@atlaskit/teams-client/use-query-light/use-lazy-query-light'` instead.
+ */
+export { useLazyQueryLight } from './useLazyQueryLight';