@atlaskit/teams-client 4.0.0

package/dist/es2019/mocks/endpoints.js

@@ -0,0 +1,250 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+
+import { mockTeamMembershipResponseWithNEdges } from './generate-data';
+import { getJoinOrRequestDefaultAccessToProductsBulkSuccessResponse } from './invitations';
+import { MOCK_EXTERNAL_TEAM_RESPONSE, MOCK_INVITE_ONLY_TEAM_RESPONSE, MOCK_INVITE_ONLY_TEAM_WRITE_PERMISSION_RESPONSE, MOCK_ME_RESPONSE, MOCK_MEMBERS_ME_ADMIN_RESPONSE, MOCK_MEMBERS_ME_MEMBER_RESPONSE, MOCK_MEMBERS_ME_REQUESTING_RESPONSE, MOCK_OPEN_TEAM_RESPONSE, MOCK_OPEN_TEAM_WRITE_PERMISSION_RESPONSE, MOCK_PRODUCT_RECOMMENDATIONS_RESPONSE, MOCK_PROFILE_MUTABILITY_RESPONSE, MOCK_TEAM_MEMBERSHIP_RESPONSE } from './responses';
+export const mockTeamsClientEndpoints = config => {
+  var _config$endpointConfi, _config$endpointConfi2, _config$endpointConfi3, _config$endpointConfi4;
+  if (config.restoreFetchMock) {
+    config.fetchMock.restore();
+  }
+  if (((_config$endpointConfi = config.endpointConfig) === null || _config$endpointConfi === void 0 ? void 0 : _config$endpointConfi.teamType) === 'inviteOnly') {
+    mockInviteOnlyTeamEndpoint(config);
+  } else if (((_config$endpointConfi2 = config.endpointConfig) === null || _config$endpointConfi2 === void 0 ? void 0 : _config$endpointConfi2.teamType) === 'external') {
+    mockExternalTeamEndpoint(config);
+  } else {
+    mockOpenTeamWritePermissionEndpoint(config);
+  }
+  if (((_config$endpointConfi3 = config.endpointConfig) === null || _config$endpointConfi3 === void 0 ? void 0 : _config$endpointConfi3.memberStatus) === 'requestingToJoin') {
+    mockMembersMeRequestingToJoinEndpoint(config);
+  } else if (((_config$endpointConfi4 = config.endpointConfig) === null || _config$endpointConfi4 === void 0 ? void 0 : _config$endpointConfi4.memberStatus) === 'notMember') {
+    mockMembersMeNotMemberEndpoint(config);
+  } else {
+    mockMembersMeFullMemberEndpoint(config);
+  }
+  mockMeEndpoint(config);
+  mockTeamMembershipEndpoint(config);
+  mockProductRecommendationsEndpoint(config);
+  mockJoinOrRequestDefaultAccessToProductsBulkEndpoint(config);
+  mockProfileWithMutabilityEndpoint(config);
+  mockCatchAll(config);
+};
+export const mockTeamsClientRequestingToJoinEndpoints = config => {
+  if (config.restoreFetchMock) {
+    config.fetchMock.restore();
+  }
+  mockInviteOnlyTeamEndpoint(config);
+  mockMembersMeRequestingToJoinEndpoint(config);
+  mockMeEndpoint(config);
+  mockTeamMembershipEndpoint(config);
+  mockProductRecommendationsEndpoint(config);
+  mockJoinOrRequestDefaultAccessToProductsBulkEndpoint(config);
+  mockProfileWithMutabilityEndpoint(config);
+  mockCatchAll(config);
+};
+export const mockTeamsClientNotMemberEndpoints = config => {
+  if (config.restoreFetchMock) {
+    config.fetchMock.restore();
+  }
+  mockTeamEndpoint(config);
+  mockMembersMeNotMemberEndpoint(config);
+  mockMeEndpoint(config);
+  mockTeamMembershipEndpoint(config);
+  mockProductRecommendationsEndpoint(config);
+  mockJoinOrRequestDefaultAccessToProductsBulkEndpoint(config);
+  mockProfileWithMutabilityEndpoint(config);
+  mockCatchAll(config);
+};
+export const mockTeamsClientAdminEndpoints = config => {
+  if (config.restoreFetchMock) {
+    config.fetchMock.restore();
+  }
+  mockOpenTeamWritePermissionEndpoint(config);
+  mockMembersMeAdminEndpoint(config);
+  mockMeEndpoint(config);
+  mockTeamMembershipEndpoint(config);
+  mockProductRecommendationsEndpoint(config);
+  mockJoinOrRequestDefaultAccessToProductsBulkEndpoint(config);
+  mockProfileWithMutabilityEndpoint(config);
+  mockCatchAll(config);
+};
+export const mockTeamsClientInviteOnlyMemberEndpoints = config => {
+  if (config.restoreFetchMock) {
+    config.fetchMock.restore();
+  }
+  mockInviteOnlyTeamWritePermissionEndpoint(config);
+  mockMembersMeFullMemberEndpoint(config);
+  mockMeEndpoint(config);
+  mockTeamMembershipEndpoint(config);
+  mockProductRecommendationsEndpoint(config);
+  mockJoinOrRequestDefaultAccessToProductsBulkEndpoint(config);
+  mockProfileWithMutabilityEndpoint(config);
+  mockCatchAll(config);
+};
+const mockMeRegex = /\/gateway\/api\/me/;
+const mockMeEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockMeRegex, (_, options) => MOCK_ME_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockMembersRegex = /\/gateway\/api\/.*teams\/.*\/membership\/me/;
+const mockMembersMeFullMemberEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockMembersRegex, (_, options) => MOCK_MEMBERS_ME_MEMBER_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockMembersMeRequestingToJoinEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockMembersRegex, (_, options) => MOCK_MEMBERS_ME_REQUESTING_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockMembersMeAdminEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockMembersRegex, (_, options) => MOCK_MEMBERS_ME_ADMIN_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockMembersMeNotMemberEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockMembersRegex, 404, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockTeamMembershipRegex = /\/gateway\/api\/graphql\?q=TeamMembership/;
+const mockTeamMembershipEndpoint = ({
+  fetchMock,
+  delay,
+  faker,
+  endpointConfig
+}) => {
+  var _endpointConfig$teamM;
+  const count = endpointConfig === null || endpointConfig === void 0 ? void 0 : (_endpointConfig$teamM = endpointConfig.teamMembership) === null || _endpointConfig$teamM === void 0 ? void 0 : _endpointConfig$teamM.count;
+  // Use a static response as default, for snapshot tests
+  const response = !faker || !count || count === 21 ? MOCK_TEAM_MEMBERSHIP_RESPONSE : mockTeamMembershipResponseWithNEdges({
+    faker
+  }, count);
+  fetchMock.post(mockTeamMembershipRegex, (_, options) => response, {
+    method: 'POST',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockTeamRegex = /\/gateway\/api\/.*teams\/[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}\?siteId=.*$/;
+const mockTeamEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockTeamRegex, (test, options) => MOCK_OPEN_TEAM_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockInviteOnlyTeamEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockTeamRegex, (test, options) => MOCK_INVITE_ONLY_TEAM_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockExternalTeamEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockTeamRegex, (test, options) => MOCK_EXTERNAL_TEAM_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockInviteOnlyTeamWritePermissionEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockTeamRegex, (test, options) => MOCK_INVITE_ONLY_TEAM_WRITE_PERMISSION_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockOpenTeamWritePermissionEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockTeamRegex, (test, options) => MOCK_OPEN_TEAM_WRITE_PERMISSION_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockProfileWithMutabilityRegex = /\/gateway\/api\/users\/manage\/.*\/profile/;
+const mockProfileWithMutabilityEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockProfileWithMutabilityRegex, (_, options) => MOCK_PROFILE_MUTABILITY_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockProductRecommendationsRegex = /\/gateway\/api\/invitations\/v1\/product-recommendations\?orgId=test-orgId&.*/;
+const mockProductRecommendationsEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.get(mockProductRecommendationsRegex, (_, options) => MOCK_PRODUCT_RECOMMENDATIONS_RESPONSE, {
+    method: 'GET',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockJoinOrRequestDefaultAccessToProductsBulkRegex = /\/gateway\/api\/invitations\/v1\/access-requests\/bulk\/request/;
+const mockJoinOrRequestDefaultAccessToProductsBulkEndpoint = ({
+  fetchMock,
+  delay
+}) => {
+  fetchMock.post(mockJoinOrRequestDefaultAccessToProductsBulkRegex, (_, options) => {
+    const request = JSON.parse(options.body);
+    const aris = request.resources.map(resource => resource.ari);
+    return getJoinOrRequestDefaultAccessToProductsBulkSuccessResponse(aris);
+  }, {
+    method: 'POST',
+    overwriteRoutes: true,
+    delay
+  });
+};
+const mockCatchAll = ({
+  fetchMock
+}) => {
+  fetchMock.mock('*', path => {
+    // eslint-disable-next-line no-console
+    console.error(`Unmatched request: ${path}`);
+  });
+};

package/dist/es2019/mocks/generate-data.js

@@ -0,0 +1,96 @@
+import { randomUser } from '../mocks/user';
+import avatar1 from './images/avatar-1.png';
+import avatar2 from './images/avatar-2.png';
+import avatar3 from './images/avatar-3.png';
+import avatar4 from './images/avatar-4.png';
+import avatar5 from './images/avatar-5.png';
+export const randomTeamMembership = ({
+  faker
+}, customProps = {}) => {
+  const user = randomUser({
+    faker
+  });
+  return {
+    state: faker.random.arrayElement(['FULL_MEMBER', 'ALUMNI', 'INVITED']),
+    user,
+    membershipId: {
+      teamId: faker.random.uuid(),
+      memberId: user.id
+    },
+    role: faker.random.arrayElement(['ADMIN', 'REGULAR']),
+    ...customProps
+  };
+};
+export const randomTeamMemberships = (config, n = 10, customProps = {}) => [...Array(n)].map(() => {
+  return {
+    ...randomTeamMembership(config, customProps)
+  };
+});
+export const fixedTeamMemberships = (n = 10) => {
+  return [...Array(n)].map((_, idx) => ({
+    state: 'FULL_MEMBER',
+    user: {
+      id: `FIXED-NUMBER-ID-${idx}`,
+      avatarUrl: `https://avatar.com/${idx}`,
+      fullName: `Fixed User Fullname ${idx}`,
+      nickname: `fixedUserName_${idx}`,
+      title: `Fixed Job Title ${idx}`,
+      userType: 'user'
+    },
+    membershipId: {
+      teamId: `FIXED-TEAM-ID-${idx}`,
+      memberId: `FIXED-NUMBER-ID-${idx}`
+    },
+    role: 'REGULAR'
+  }));
+};
+// tslint:disable-next-line:no-any
+export function randomReturnedNewTeamData({
+  faker
+}, customProps = {}) {
+  return {
+    id: faker.random.uuid(),
+    creatorId: faker.random.uuid(),
+    displayName: faker.finance.accountName(),
+    description: faker.lorem.words(20),
+    organizationId: undefined,
+    permission: 'FULL_WRITE',
+    membershipSettings: 'OPEN',
+    state: 'ACTIVE',
+    discoverable: 'DISCOVERABLE',
+    restriction: 'NO_RESTRICTION',
+    creatorDomain: 'c6080332a525e35ccd7b699a80a128e49a0acce5009e275bfdbc4ad53814eb2b',
+    ...customProps
+  };
+}
+export const mockTeamMembershipResponseWithNEdges = ({
+  faker
+}, n) => ({
+  data: {
+    team: {
+      teamV2: {
+        members: {
+          edges: [...Array(n)].map(() => ({
+            node: {
+              role: 'REGULAR',
+              state: 'FULL_MEMBER',
+              member: {
+                name: `${faker.name.firstName()} ${faker.name.lastName()}`,
+                picture: faker.random.arrayElement([avatar1, avatar2, avatar3, avatar4, avatar5]),
+                accountStatus: 'active',
+                extendedProfile: {
+                  jobTitle: faker.name.jobTitle()
+                },
+                id: `ari:cloud:identity::user/${faker.random.uuid()}`
+              }
+            }
+          })),
+          pageInfo: {
+            endCursor: null,
+            hasNextPage: false
+          }
+        }
+      }
+    }
+  }
+});

package/dist/es2019/mocks/index.js

@@ -0,0 +1,2 @@
+export { mockTeamsClientEndpoints, mockTeamsClientRequestingToJoinEndpoints, mockTeamsClientAdminEndpoints, mockTeamsClientNotMemberEndpoints, mockTeamsClientInviteOnlyMemberEndpoints } from './endpoints';
+export { randomReturnedNewTeamData, randomTeamMembership, randomTeamMemberships, fixedTeamMemberships } from './generate-data';

package/dist/es2019/mocks/invitations.js

@@ -0,0 +1,11 @@
+export const getJoinOrRequestDefaultAccessToProductsBulkSuccessResponse = aris => aris.map(ari => ({
+  ari,
+  result: 'ACCESS_GRANTED',
+  resultsV2: {
+    [ari]: [{
+      accessMode: 'ACCESS_EXISTS',
+      role: 'product/member'
+    }]
+  },
+  errorReason: null
+}));