@atlaskit/teams-client 4.0.0

package/dist/es2019/services/identity-client/index.js

@@ -0,0 +1,53 @@
+import { DEFAULT_CONFIG } from '../constants';
+import { RestClient } from '../rest-client';
+import { dataURItoFile, toManageAPIInput, transformUserManageConfig } from './utils';
+const defaultConfig = {
+  serviceUrl: `${DEFAULT_CONFIG.stargateRoot}/users`
+};
+export class IdentityClient extends RestClient {
+  constructor(config = {}) {
+    super({
+      ...defaultConfig,
+      ...config
+    });
+  }
+  async getUserManageConfig(userId) {
+    return this.getResourceCached(`/${userId}/manage`).then(resp => {
+      return transformUserManageConfig(resp);
+    });
+  }
+
+  /**
+   * @deprecated
+   * User fetchUserAvatarInfo instead
+   */
+  async getMyAvatarUploadedStatus(userId) {
+    return this.fetchUserAvatarInfo(userId);
+  }
+  async deleteAvatar(userId) {
+    return this.deleteResource(`/${userId}/manage/avatar`);
+  }
+  async fetchUserAvatarInfo(userId) {
+    return this.getResource(`/${userId}/manage/avatar`);
+  }
+  async updateUser({
+    id,
+    ...user
+  }) {
+    return this.patchResource(`/${id}/manage/profile`, toManageAPIInput(user));
+  }
+  async updateUserAvatar({
+    id,
+    fileURI
+  }) {
+    const fileObject = dataURItoFile(fileURI);
+    const formData = new FormData();
+    formData.append('file', fileObject);
+    const response = await this.makeRequest(`/${id}/manage/avatar`, {
+      method: 'PUT',
+      body: formData
+    });
+    return response.url;
+  }
+}
+export default new IdentityClient();

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

@@ -0,0 +1,167 @@
+import { formatInTimeZone } from 'date-fns-tz';
+// Key (left-side) is field name which is used in our app.
+// Value (right-side) is field name which is used by data in services
+const PROFILE_PROPS_MAP = new Map([['id', 'account_id'], ['fullName', 'name'], ['nickname', 'nickname'], ['timezone', 'zoneinfo'], ['locale', 'locale'], ['avatarUrl', 'picture'], ['email', 'email']]);
+
+// Key (left-side) is field name which is used in our app.
+// Value (right-side) is field name which is used by data in services
+const EXTENDED_PROFILE_PROPS_MAP = new Map([['title', 'job_title'], ['department', 'department'], ['companyName', 'organization'], ['location', 'location'], ['phoneNumber', 'phone_number']]);
+export const fromManageAPIResponse = res => {
+  const data = res.account;
+  const extendedData = data && data.extended_profile || {};
+  if (!data) {
+    return null;
+  }
+  const timeZone = data.zoneinfo;
+  const localTime = ({
+    format
+  }) => {
+    if (!timeZone) {
+      return null;
+    }
+    try {
+      return formatInTimeZone(new Date(), timeZone, format);
+    } catch (error) {
+      // TODO: PTC-4908 send error to sentry for reporting
+      return null;
+    }
+  };
+  const profileProps = Array.from(PROFILE_PROPS_MAP.keys()).reduce((acc, key) => {
+    if (PROFILE_PROPS_MAP.has(key)) {
+      acc[key] = data[PROFILE_PROPS_MAP.get(key)];
+    }
+    return acc;
+  }, {});
+  const extendedProfileProps = Array.from(EXTENDED_PROFILE_PROPS_MAP.keys()).reduce((acc, key) => {
+    if (EXTENDED_PROFILE_PROPS_MAP.has(key)) {
+      acc[key] = extendedData[EXTENDED_PROFILE_PROPS_MAP.get(key)];
+    }
+    return acc;
+  }, {});
+  return {
+    ...profileProps,
+    ...extendedProfileProps,
+    localTime
+  };
+};
+
+// Copied from ptc-common/user type to not messing up dependency
+export let FieldType = /*#__PURE__*/function (FieldType) {
+  FieldType["FullName"] = "fullName";
+  FieldType["Nickname"] = "nickname";
+  // aka `Public name`
+  FieldType["Title"] = "title";
+  FieldType["Department"] = "department";
+  FieldType["CompanyName"] = "companyName";
+  FieldType["Location"] = "location";
+  FieldType["Timezone"] = "timezone";
+  FieldType["Email"] = "email";
+  FieldType["PhoneNumber"] = "phoneNumber";
+  FieldType["Avatar"] = "picture";
+  FieldType["Language"] = "language";
+  FieldType["LocalTime"] = "localTime";
+  FieldType["RemoteWeekdayIndex"] = "remoteWeekdayIndex";
+  FieldType["RemoteWeekdayString"] = "remoteWeekdayString";
+  FieldType["RemoteTimeString"] = "remoteTimeString";
+  return FieldType;
+}({});
+export const MUTABILITY_DETAILS_MAP = {
+  fullName: 'name',
+  nickname: 'nickname',
+  timezone: 'zoneinfo',
+  locale: 'locale',
+  email: 'email',
+  // extended profile
+  title: 'extended_profile.job_title',
+  phoneNumber: 'extended_profile.phone_number',
+  companyName: 'extended_profile.organization',
+  department: 'extended_profile.department',
+  location: 'extended_profile.location'
+};
+export const CUSTOM_FIELD_PLACE = {
+  email: 'email.initiateChange',
+  picture: 'avatar'
+};
+const getFieldConfig = (data, field) => {
+  if ((field === 'email' || field === 'picture') && CUSTOM_FIELD_PLACE[field]) {
+    return data[CUSTOM_FIELD_PLACE[field]];
+  }
+  const mappedFieldKey = field in MUTABILITY_DETAILS_MAP ? MUTABILITY_DETAILS_MAP[field] : undefined;
+  if (!mappedFieldKey) {
+    return undefined;
+  }
+  const profileWrite = data['profile.write'];
+  return profileWrite[mappedFieldKey];
+};
+const convertFieldKeyToFieldType = key => {
+  // Check if the key can be mapped to a FieldType value
+  if (Object.values(FieldType).includes(key)) {
+    return key;
+  }
+  return undefined;
+};
+const getMutabilityConstraintFor = (data, field) => {
+  const fieldConfig = getFieldConfig(data, field);
+  if (!fieldConfig || fieldConfig.allowed) {
+    return undefined;
+  }
+  const convertedField = convertFieldKeyToFieldType(field);
+  if (!convertedField) {
+    return undefined;
+  }
+  const reason = fieldConfig.reason;
+  return {
+    field: convertedField,
+    reason: reason && reason.key || null
+  };
+};
+export const transformUserManageConfig = data => ({
+  mutabilityConstraints: Object.keys(MUTABILITY_DETAILS_MAP).map(field => getMutabilityConstraintFor(data, field)).filter(constraint => constraint !== undefined)
+});
+export const toManageAPIInput = input => {
+  const output = {
+    extended_profile: {}
+  };
+  Object.keys(input).forEach(key => {
+    if (PROFILE_PROPS_MAP.has(key)) {
+      output[PROFILE_PROPS_MAP.get(key)] = input[key];
+    }
+    if (EXTENDED_PROFILE_PROPS_MAP.has(key)) {
+      output.extended_profile[EXTENDED_PROFILE_PROPS_MAP.get(key)] = input[key];
+    }
+  });
+  return output;
+};
+export function dataURItoFile(dataURI, filename = 'untitled') {
+  if (dataURI.length === 0) {
+    throw new Error('dataURI not found');
+  }
+
+  // convert base64/URLEncoded data component to raw binary data held in a string
+  const byteString = dataURI.split(',')[0].includes('base64') ? atob(dataURI.split(',')[1]) : decodeURIComponent(dataURI.split(',')[1]);
+
+  // separate out the mime component
+  let mimeString;
+  try {
+    mimeString = dataURI.split(',')[0].split(':')[1].split(';')[0];
+  } catch (e) {
+    mimeString = 'unknown';
+  }
+
+  // write the bytes of the string to a typed array
+  const intArray = new Uint8Array(byteString.length);
+  for (let i = 0; i < byteString.length; i++) {
+    intArray[i] = byteString.charCodeAt(i);
+  }
+  const blob = new Blob([intArray], {
+    type: mimeString
+  });
+  try {
+    return new File([blob], filename, {
+      type: mimeString
+    });
+  } catch (e) {
+    // IE11 and Safari does not support the File constructor.
+    return blob;
+  }
+}

package/dist/es2019/services/index.js

@@ -0,0 +1 @@
+export { teamsClient, TeamsClient } from './main';

package/dist/es2019/services/invitations-client/index.js

@@ -0,0 +1,65 @@
+import { DEFAULT_CONFIG } from '../constants';
+import { RestClient } from '../rest-client';
+import { logException } from '../sentry/main';
+import { removeDuplicateRecommendations } from './utils';
+const PRODUCT_RECCOMENDATIONS = '/v1/product-recommendations';
+const PRODUCT_JOIN_OR_REQUEST_BULK = '/v1/access-requests/bulk/request';
+const ALL_SUPPORTED_PRODUCTS = ['confluence', 'jira', 'jira-core', 'jira-servicedesk', 'jira-software', 'jira-incident-manager', 'jira-product-discovery', 'opsgenie', 'statuspage', 'avocado', 'townsquare', 'compass', 'avp', 'beacon', 'mercury'];
+export class InvitationsClient extends RestClient {
+  constructor(serviceUrl, config) {
+    super({
+      serviceUrl,
+      config
+    });
+  }
+  async getProductRecommendationsInner(supportedProducts = ALL_SUPPORTED_PRODUCTS, capabilities) {
+    try {
+      const orgId = this.getOrgId();
+      const queryProducts = supportedProducts && supportedProducts.length > 0 ? supportedProducts : ALL_SUPPORTED_PRODUCTS;
+      const productQueryParams = queryProducts.map(product => `product=${product}`).join('&');
+      const capabilityQueryParams = capabilities && capabilities.length > 0 ? '&' + capabilities.map(capability => `capability=${capability}`).join('&') : '';
+      const url = `${PRODUCT_RECCOMENDATIONS}?orgId=${orgId}&${productQueryParams}${capabilityQueryParams}`;
+      return await this.getResource(url);
+    } catch (error) {
+      this.logException(error, 'An error occurred while getting product recommendations.');
+      throw error;
+    }
+  }
+  async getProductRecommendations(supportedProducts = ALL_SUPPORTED_PRODUCTS, capabilities) {
+    // This endpoint may return duplicate resource ARIs with a different mode.
+    const result = await this.getProductRecommendationsInner(supportedProducts, capabilities);
+    try {
+      const deduplicatedResult = removeDuplicateRecommendations(result);
+      return deduplicatedResult;
+    } catch (error) {
+      this.logException(error, 'An error occurred while deduplicating product recommendations.');
+      throw error;
+    }
+  }
+  async joinOrRequestDefaultAccessToProductsBulk(simplifiedRequest) {
+    if (simplifiedRequest.productAris.length === 0) {
+      return Promise.resolve([]);
+    }
+    try {
+      const resources = simplifiedRequest.productAris.map(ari => ({
+        ari,
+        role: 'product/member'
+      }));
+      const request = {
+        resources,
+        note: simplifiedRequest.note,
+        accessMode: simplifiedRequest.accessMode,
+        source: simplifiedRequest.source
+      };
+      return await this.postResource(PRODUCT_JOIN_OR_REQUEST_BULK, request);
+    } catch (error) {
+      this.logException(error, 'An error occurred while joining or requesting access to products.');
+      throw error;
+    }
+  }
+}
+
+// eslint-disable-next-line import/no-anonymous-default-export
+export default new InvitationsClient(DEFAULT_CONFIG.invitationsServiceUrl, {
+  logException
+});

package/dist/es2019/services/invitations-client/utils/index.js

@@ -0,0 +1,101 @@
+/**
+ * Determines which capability is more desirable.
+ * Users desire direct access over request access since it's instant.
+ * @returns 0 if equal, -1 if a is more desirable, 1 if b is more desirable.
+ */
+const compareCapability = (a, b) => {
+  if (a === b) {
+    return 0;
+  }
+  return a === 'DIRECT_ACCESS' ? -1 : 1;
+};
+
+/**
+ * Determines which mode is more desirable.
+ * Atlassian prefers to provide open access over domain restricted access.
+ * Both of these modes have already been enabled by an admin.
+ * If mode is undefined, it is deemed least desirable.
+ * @returns 0 if equal, -1 if a is more open, 1 if b is more open.
+ */
+const compareMode = (a, b) => {
+  if (a === b) {
+    return 0;
+  }
+  if (!a) {
+    return 1;
+  }
+  if (!b) {
+    return -1;
+  }
+  return a === 'OPEN' ? -1 : 1;
+};
+
+/**
+ * Determine if a recommendation is more desirable than another.
+ * Atlassian prefers a better capability over any mode setting.
+ * The mode will only be compared if the capabilities are equal.
+ * If both capability and mode are equal, the recommendations are considered the same.
+ *
+ * Assumes recommendations have the same resource ID.
+ * Do not compare recommendations with different resource IDs, as it does not make sense.
+ *
+ * @returns 0 if capability and mode are equal, -1 if a is more desirable, 1 if b is more desirable.
+ */
+const compareRecommendations = (a, b) => {
+  if (a.resourceId !== b.resourceId) {
+    throw new Error('Recommendations must have the same resource ID');
+  }
+  if (compareCapability(a.capability, b.capability) < 0) {
+    return -1;
+  } else if (compareCapability(a.capability, b.capability) > 0) {
+    return 1;
+  } else if (compareMode(a.mode, b.mode) < 0) {
+    return -1;
+  } else if (compareMode(a.mode, b.mode) > 0) {
+    return 1;
+  }
+  return 0;
+};
+const toRecommendation = recommendation => {
+  const {
+    capability,
+    ...rest
+  } = recommendation;
+  return {
+    ...rest
+  };
+};
+
+/**
+ * Removes duplicate recommendations with the same resource ARI.
+ * When a collision occurs, select the recommendation with the most desirable capability and mode.
+ * @returns a recommendation response with unique resource ARIs.
+ */
+export const removeDuplicateRecommendations = recommendations => {
+  const {
+    DIRECT_ACCESS,
+    REQUEST_ACCESS
+  } = recommendations.capability;
+  const uniqueRecommendations = {};
+  const allRecommendations = [...DIRECT_ACCESS.map(recommendation => ({
+    ...recommendation,
+    capability: 'DIRECT_ACCESS'
+  })), ...REQUEST_ACCESS.map(recommendation => ({
+    ...recommendation,
+    capability: 'REQUEST_ACCESS'
+  }))];
+  allRecommendations.forEach(recommendation => {
+    const existing = uniqueRecommendations[recommendation.resourceId];
+    if (existing && compareRecommendations(existing, recommendation) <= 0) {
+      return;
+    }
+    uniqueRecommendations[recommendation.resourceId] = recommendation;
+  });
+  const allUniqueRecommendations = Object.values(uniqueRecommendations);
+  return {
+    capability: {
+      DIRECT_ACCESS: allUniqueRecommendations.filter(recommendation => recommendation.capability === 'DIRECT_ACCESS').map(toRecommendation),
+      REQUEST_ACCESS: allUniqueRecommendations.filter(recommendation => recommendation.capability === 'REQUEST_ACCESS').map(toRecommendation)
+    }
+  };
+};

package/dist/es2019/services/invitations-client/utils/types.js

@@ -0,0 +1 @@
+export {};