@atlaskit/media-client 37.2.37 → 37.3.0

package/dist/es2019/utils/overrideMediaTypeIfUnknown.js

@@ -1,4 +1,4 @@
-import { isErrorFileState } from '../models/file-state';
+import { isErrorFileState } from '../models/is-error-file-state';
 export const overrideMediaTypeIfUnknown = (fileState, mediaType) => {
   if (!isErrorFileState(fileState) && fileState.mediaType === 'unknown') {
     return {

package/dist/es2019/utils/pathBasedUrl.js

@@ -1,45 +1 @@
-import { fg } from '@atlaskit/platform-feature-flags';
-import getDocument from './getDocument';
-const mediaApiPathPrefix = '/media-api';
-function getRelativeUrl(absoluteUrl) {
-  const url = new URL(absoluteUrl);
-  return `${url.pathname}${url.search}${url.hash}`;
-}
-export function isPathBasedEnabled() {
-  var _getDocument, _getDocument$location;
-  const isLocalhost = ((_getDocument = getDocument()) === null || _getDocument === void 0 ? void 0 : (_getDocument$location = _getDocument.location) === null || _getDocument$location === void 0 ? void 0 : _getDocument$location.hostname) === 'localhost';
-  return fg('platform_media_path_based_route') && !isLocalhost;
-}
-export function mapToPathBasedUrl(url) {
-  if (isPathBasedEnabled()) {
-    var _getDocument2;
-    const parsedUrl = new URL(url);
-    if (!parsedUrl.pathname.startsWith(mediaApiPathPrefix)) {
-      parsedUrl.pathname = `${mediaApiPathPrefix}${parsedUrl.pathname}`;
-    }
-    const location = (_getDocument2 = getDocument()) === null || _getDocument2 === void 0 ? void 0 : _getDocument2.location;
-
-    // in this case we are most likely in SSR / a non browser environment so just return a relative URL
-    if (!location) {
-      return getRelativeUrl(parsedUrl.toString());
-    }
-    parsedUrl.host = location.host;
-    return parsedUrl.toString();
-  }
-  return url;
-}
-export function mapRetryUrlToPathBasedUrl(url) {
-  var _getDocument$location2, _getDocument3;
-  const parsedUrl = new URL(url);
-  parsedUrl.host = (_getDocument$location2 = (_getDocument3 = getDocument()) === null || _getDocument3 === void 0 ? void 0 : _getDocument3.location.host) !== null && _getDocument$location2 !== void 0 ? _getDocument$location2 : '';
-
-  // remove CDN from the URL for retry if it exists
-  const pathname = parsedUrl.pathname;
-  if (pathname.endsWith('/cdn')) {
-    parsedUrl.pathname = pathname.replace('/cdn', '');
-  }
-  if (!parsedUrl.pathname.startsWith(mediaApiPathPrefix)) {
-    parsedUrl.pathname = `${mediaApiPathPrefix}${parsedUrl.pathname}`;
-  }
-  return parsedUrl;
-}
+export const mediaApiPathPrefix = '/media-api';

package/dist/es2019/utils/polling/PollingError.js

@@ -0,0 +1,21 @@
+import { BaseMediaClientError } from '../../models/errors/BaseMediaClientError';
+export class PollingError extends BaseMediaClientError {
+  constructor(reason, metadata) {
+    super(reason, metadata, undefined);
+  }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
+  get attributes() {
+    const {
+      reason,
+      metadata: {
+        attempts
+      }
+    } = this;
+    return {
+      reason,
+      attempts
+    };
+  }
+}

package/dist/es2019/utils/polling/errors.js

@@ -1,24 +1,9 @@
-import { BaseMediaClientError } from '../../models/errors';
-export class PollingError extends BaseMediaClientError {
-  constructor(reason, metadata) {
-    super(reason, metadata, undefined);
-  }
-
-  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
-  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
-  get attributes() {
-    const {
-      reason,
-      metadata: {
-        attempts
-      }
-    } = this;
-    return {
-      reason,
-      attempts
-    };
-  }
-}
-export function isPollingError(err) {
-  return err instanceof PollingError;
-}
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import { PollingError } from '@atlaskit/media-client/polling'` instead.
+ */
+export { PollingError } from './PollingError';
+/**
+ * @deprecated Use `import { isPollingError } from '@atlaskit/media-client/polling'` instead.
+ */
+export { isPollingError } from './isPollingError';

package/dist/es2019/utils/polling/index.js

@@ -1,6 +1,14 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { PollingError } from './errors';
-export { PollingError, isPollingError } from './errors';
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+import { PollingError } from './PollingError';
+/**
+ * @deprecated Use `import { PollingError } from '@atlaskit/media-client/polling/errors'` instead.
+ */
+export { PollingError } from './PollingError';
+/**
+ * @deprecated Use `import { isPollingError } from '@atlaskit/media-client/polling/errors'` instead.
+ */
+export { isPollingError } from './isPollingError';
 // default polling options without using feature flags
 export const defaultPollingOptions = {
   poll_intervalMs: 3000,

package/dist/es2019/utils/polling/isPollingError.js

@@ -0,0 +1,4 @@
+import { PollingError } from './PollingError';
+export function isPollingError(err) {
+  return err instanceof PollingError;
+}

package/dist/es2019/utils/rejectTimeout.js

@@ -0,0 +1,3 @@
+export const rejectTimeout = (timeout, rejectWith) => new Promise((_resolve, reject) => {
+  setTimeout(reject, timeout, rejectWith);
+});

package/dist/es2019/utils/request/RequestError.js

@@ -0,0 +1,39 @@
+import { BaseMediaClientError } from '../../models/errors/BaseMediaClientError';
+export class RequestError extends BaseMediaClientError {
+  constructor(reason, metadata, innerError) {
+    super(reason, metadata, innerError);
+  }
+
+  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
+  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
+  get attributes() {
+    const {
+      reason,
+      metadata: {
+        method,
+        endpoint,
+        mediaRegion,
+        mediaEnv,
+        attempts,
+        clientExhaustedRetries,
+        statusCode,
+        traceContext
+      } = {},
+      innerError
+    } = this;
+    return {
+      reason,
+      method,
+      endpoint,
+      mediaRegion,
+      mediaEnv,
+      attempts,
+      clientExhaustedRetries,
+      statusCode,
+      metadata: {
+        traceContext
+      },
+      innerError
+    };
+  }
+}

package/dist/es2019/utils/request/cloneRequestError.js

@@ -0,0 +1,12 @@
+import { RequestError } from './RequestError';
+export function cloneRequestError(error, extraMetadata) {
+  const {
+    reason,
+    metadata,
+    innerError
+  } = error;
+  return new RequestError(reason, {
+    ...metadata,
+    ...extraMetadata
+  }, innerError);
+}

package/dist/es2019/utils/request/createMapResponseToBlob.js

@@ -0,0 +1,15 @@
+import { RequestError } from './RequestError';
+import { extractMediaHeaders } from './extractMediaHeaders';
+export function createMapResponseToBlob(metadata) {
+  return async response => {
+    try {
+      return await response.blob();
+    } catch (err) {
+      throw new RequestError('serverInvalidBody', {
+        ...metadata,
+        ...extractMediaHeaders(response),
+        statusCode: response.status
+      }, err instanceof Error ? err : undefined);
+    }
+  };
+}

package/dist/es2019/utils/request/createMapResponseToJson.js

@@ -0,0 +1,15 @@
+import { RequestError } from './RequestError';
+import { extractMediaHeaders } from './extractMediaHeaders';
+export function createMapResponseToJson(metadata) {
+  return async response => {
+    try {
+      return await response.json();
+    } catch (err) {
+      throw new RequestError('serverInvalidBody', {
+        ...metadata,
+        ...extractMediaHeaders(response),
+        statusCode: response.status
+      }, err instanceof Error ? err : undefined);
+    }
+  };
+}

package/dist/es2019/utils/request/createProcessFetchResponse.js

@@ -0,0 +1,10 @@
+import { createRequestErrorFromResponse } from './createRequestErrorFromResponse';
+export function createProcessFetchResponse(metadata) {
+  return response => {
+    if (response.ok || response.status < 400) {
+      return response;
+    }
+    const requestError = createRequestErrorFromResponse(metadata, response);
+    throw requestError;
+  };
+}

package/dist/es2019/utils/request/createRequestErrorFromResponse.js

@@ -0,0 +1,14 @@
+import { RequestError } from './RequestError';
+import { createRequestErrorReason } from './createRequestErrorReason';
+import { extractMediaHeaders } from './extractMediaHeaders';
+export function createRequestErrorFromResponse(metadata, response) {
+  const {
+    status: statusCode
+  } = response;
+  const reason = createRequestErrorReason(statusCode);
+  return new RequestError(reason, {
+    ...metadata,
+    ...extractMediaHeaders(response),
+    statusCode
+  });
+}

package/dist/es2019/utils/request/createRequestErrorReason.js

@@ -0,0 +1,24 @@
+export function createRequestErrorReason(statusCode) {
+  switch (statusCode) {
+    case 400:
+      return 'serverBadRequest';
+    case 401:
+      return 'serverUnauthorized';
+    case 403:
+      return 'serverForbidden';
+    case 404:
+      return 'serverNotFound';
+    case 422:
+      return 'serverUnprocessableEntity';
+    case 423:
+      return 'serverEntityLocked';
+    case 429:
+      return 'serverRateLimited';
+    case 500:
+      return 'serverInternalError';
+    case 502:
+      return 'serverBadGateway';
+    default:
+      return 'serverUnexpectedError';
+  }
+}

package/dist/es2019/utils/request/createUrl.js

@@ -0,0 +1,17 @@
+import { mapAuthToQueryParameters } from '../../models/auth-query-parameters';
+export function createUrl(url, {
+  params,
+  auth
+}) {
+  const parsedUrl = new URL(url, auth === null || auth === void 0 ? void 0 : auth.baseUrl);
+  const authParams = auth && mapAuthToQueryParameters(auth) || {};
+  const paramsToAppend = {
+    ...params,
+    ...authParams
+  };
+  Object.entries(paramsToAppend).filter(([_, value]) => value != null).forEach(pair => {
+    parsedUrl.searchParams.set(...pair);
+  });
+  parsedUrl.searchParams.sort();
+  return parsedUrl.toString();
+}

package/dist/es2019/utils/request/defaultShouldRetryError.js

@@ -0,0 +1,6 @@
+import { getStatusCode } from './getStatusCode';
+import { isFetchNetworkError } from './isFetchNetworkError';
+export const defaultShouldRetryError = err => {
+  const statusCode = getStatusCode(err);
+  return isFetchNetworkError(err) || (statusCode ? statusCode >= 500 : false);
+};

package/dist/es2019/utils/request/errors.js

@@ -1,42 +1,9 @@
-import { BaseMediaClientError } from '../../models/errors';
-export class RequestError extends BaseMediaClientError {
-  constructor(reason, metadata, innerError) {
-    super(reason, metadata, innerError);
-  }
-
-  // TODO: Deprecate this getter https://product-fabric.atlassian.net/browse/CXP-4665
-  /** Will be deprecated. Use the properties `reason` and `metadata` instead */
-  get attributes() {
-    const {
-      reason,
-      metadata: {
-        method,
-        endpoint,
-        mediaRegion,
-        mediaEnv,
-        attempts,
-        clientExhaustedRetries,
-        statusCode,
-        traceContext
-      } = {},
-      innerError
-    } = this;
-    return {
-      reason,
-      method,
-      endpoint,
-      mediaRegion,
-      mediaEnv,
-      attempts,
-      clientExhaustedRetries,
-      statusCode,
-      metadata: {
-        traceContext
-      },
-      innerError
-    };
-  }
-}
-export function isRequestError(err) {
-  return err instanceof RequestError;
-}
+/* eslint-disable @repo/internal/deprecations/deprecation-ticket-required -- VOLTC-139 tracks removal of these deprecated re-export shims. */
+/**
+ * @deprecated Use `import { RequestError } from '@atlaskit/media-client/request'` instead.
+ */
+export { RequestError } from './RequestError';
+/**
+ * @deprecated Use `import { isRequestError } from '@atlaskit/media-client/request'` instead.
+ */
+export { isRequestError } from './isRequestError';

package/dist/es2019/utils/request/extendHeaders.js

@@ -0,0 +1,18 @@
+import { ZipkinHeaderKeys } from './helpers';
+import { mapAuthToRequestHeaders } from './mapAuthToRequestHeaders';
+const mapTraceIdToRequestHeaders = traceContext => {
+  return traceContext ? {
+    [ZipkinHeaderKeys.traceId]: traceContext.traceId,
+    [ZipkinHeaderKeys.spanId]: traceContext.spanId
+  } : {};
+};
+export function extendHeaders(headers, auth, traceContext) {
+  if (!auth && !traceContext && !headers) {
+    return undefined;
+  }
+  return {
+    ...(headers !== null && headers !== void 0 ? headers : {}),
+    ...mapAuthToRequestHeaders(auth),
+    ...mapTraceIdToRequestHeaders(traceContext)
+  };
+}

package/dist/es2019/utils/request/extendTraceContext.js

@@ -0,0 +1,5 @@
+import { getRandomTelemetryId } from '@atlaskit/media-common';
+export const extendTraceContext = traceContext => traceContext ? {
+  ...traceContext,
+  spanId: (traceContext === null || traceContext === void 0 ? void 0 : traceContext.spanId) || getRandomTelemetryId()
+} : undefined;

package/dist/es2019/utils/request/extractMediaHeaders.js

@@ -0,0 +1,11 @@
+export function extractMediaHeaders(response) {
+  const {
+    headers
+  } = response;
+  const mediaRegion = headers.get('x-media-region') || 'unknown';
+  const mediaEnv = headers.get('x-media-env') || 'unknown';
+  return {
+    mediaRegion,
+    mediaEnv
+  };
+}

package/dist/es2019/utils/request/fetchRetry.js

@@ -0,0 +1,54 @@
+import { RequestError } from './RequestError';
+import { cloneRequestError } from './cloneRequestError';
+import { defaultShouldRetryError } from './defaultShouldRetryError';
+import { DEFAULT_RETRY_OPTIONS } from './helpers';
+import { isAbortedRequestError } from './isAbortedRequestError';
+import { isRequestError } from './isRequestError';
+import { waitPromise } from './waitPromise';
+export async function fetchRetry(functionToRetry, metadata, overwriteOptions = {}) {
+  const options = {
+    ...DEFAULT_RETRY_OPTIONS,
+    ...overwriteOptions
+  };
+  const {
+    startTimeoutInMs,
+    maxAttempts,
+    factor,
+    shouldRetryError = defaultShouldRetryError
+  } = options;
+  let attempts = 0;
+  let timeoutInMs = startTimeoutInMs;
+  let lastError;
+  const waitAndBumpTimeout = async () => {
+    await waitPromise(timeoutInMs);
+    timeoutInMs *= factor;
+    attempts += 1;
+  };
+  while (attempts < maxAttempts) {
+    try {
+      return await functionToRetry();
+    } catch (err) {
+      lastError = err;
+
+      // don't retry if request was aborted by user
+      if (isAbortedRequestError(err)) {
+        throw new RequestError('clientAbortedRequest', metadata, err);
+      }
+      if (!shouldRetryError(err)) {
+        throw err;
+      }
+      await waitAndBumpTimeout();
+    }
+  }
+  if (isRequestError(lastError)) {
+    throw cloneRequestError(lastError, {
+      attempts,
+      clientExhaustedRetries: true
+    });
+  }
+  throw new RequestError('serverUnexpectedError', {
+    ...metadata,
+    attempts,
+    clientExhaustedRetries: true
+  }, lastError);
+}

package/dist/es2019/utils/request/getStatusCode.js

@@ -0,0 +1,5 @@
+import { isRequestError } from './isRequestError';
+export const getStatusCode = error => {
+  var _error$metadata;
+  return isRequestError(error) && ((_error$metadata = error.metadata) === null || _error$metadata === void 0 ? void 0 : _error$metadata.statusCode) && error.metadata.statusCode;
+};