@atlaskit/emoji 67.4.10 → 67.5.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/emoji
 
+## 67.5.0
+
+### Minor Changes
+
+- [`630ece558fe`](https://bitbucket.org/atlassian/atlassian-frontend/commits/630ece558fe) - Added onlyFetchOnDemand config to disable fetching by default in EmojiCommonProvider
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 67.4.10
 
 ### Patch Changes

package/dist/cjs/api/EmojiResource.js

@@ -55,6 +55,7 @@ var EmojiResource = /*#__PURE__*/function (_ref) {
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "initialLoaders", 0);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "retries", new Map());
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "isInitialised", false);
+    (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "fetchOnDemand", false);
     (0, _defineProperty2.default)((0, _assertThisInitialized2.default)(_this), "getOptimisticImageURL", function (emojiId) {
       if (_this.emojiProviderConfig.optimisticImageApi) {
         return _this.emojiProviderConfig.optimisticImageApi.getUrl(emojiId);
@@ -76,6 +77,7 @@ var EmojiResource = /*#__PURE__*/function (_ref) {
     if (config.providers.length === 0) {
       throw new Error('No providers specified');
     }
+    _this.fetchOnDemand = !!config.options && !!config.options.onlyFetchOnDemand;
     _this.initialLoaders = _this.emojiProviderConfig.providers.length;
     _this.activeLoaders = _this.emojiProviderConfig.providers.length;
     _this.emojiResponses = [];
@@ -96,7 +98,7 @@ var EmojiResource = /*#__PURE__*/function (_ref) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {
-                fetchAtStart: true
+                fetchAtStart: !this.fetchOnDemand
               };
               if (!options.fetchAtStart) {
                 _context.next = 11;
@@ -219,6 +221,11 @@ var EmojiResource = /*#__PURE__*/function (_ref) {
       }
       return fetchEmojiProvider;
     }()
+  }, {
+    key: "onlyFetchOnDemand",
+    value: function onlyFetchOnDemand() {
+      return this.fetchOnDemand;
+    }
   }, {
     key: "fetchByEmojiId",
     value: function () {

package/dist/cjs/context/EmojiContextProvider.js

@@ -47,7 +47,14 @@ var EmojiContextProvider = function EmojiContextProvider(_ref) {
       }));
       return _fetchEmojiProvider.apply(this, arguments);
     }
-    fetchEmojiProvider();
+    if (memoizedEmojiContextValue !== null && memoizedEmojiContextValue !== void 0 && memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand) {
+      var isFetchingOnDemand = memoizedEmojiContextValue === null || memoizedEmojiContextValue === void 0 ? void 0 : memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand();
+      if (!isFetchingOnDemand) {
+        fetchEmojiProvider();
+      }
+    } else {
+      fetchEmojiProvider();
+    }
   }, [memoizedEmojiContextValue]);
   return /*#__PURE__*/_react.default.createElement(_EmojiContext.EmojiContext.Provider, {
     value: memoizedEmojiContextValue

package/dist/cjs/util/analytics/analytics.js

@@ -20,7 +20,7 @@ var createEvent = function createEvent(eventType, action, actionSubject, actionS
     actionSubjectId: actionSubjectId,
     attributes: _objectSpread({
       packageName: "@atlaskit/emoji",
-      packageVersion: "67.4.10"
+      packageVersion: "67.5.0"
     }, attributes)
   };
 };

package/dist/es2019/api/EmojiResource.js

@@ -30,6 +30,7 @@ export class EmojiResource extends AbstractResource {
     _defineProperty(this, "initialLoaders", 0);
     _defineProperty(this, "retries", new Map());
     _defineProperty(this, "isInitialised", false);
+    _defineProperty(this, "fetchOnDemand", false);
     _defineProperty(this, "getOptimisticImageURL", emojiId => {
       if (this.emojiProviderConfig.optimisticImageApi) {
         return this.emojiProviderConfig.optimisticImageApi.getUrl(emojiId);
@@ -49,6 +50,7 @@ export class EmojiResource extends AbstractResource {
     if (config.providers.length === 0) {
       throw new Error('No providers specified');
     }
+    this.fetchOnDemand = !!config.options && !!config.options.onlyFetchOnDemand;
     this.initialLoaders = this.emojiProviderConfig.providers.length;
     this.activeLoaders = this.emojiProviderConfig.providers.length;
     this.emojiResponses = [];
@@ -59,7 +61,7 @@ export class EmojiResource extends AbstractResource {
    * @returns Promise<EmojiProvider>
    */
   async getEmojiProvider(options = {
-    fetchAtStart: true
+    fetchAtStart: !this.fetchOnDemand
   }) {
     if (options.fetchAtStart) {
       try {
@@ -118,6 +120,9 @@ export class EmojiResource extends AbstractResource {
     }
     return Promise.resolve(this.emojiRepository);
   }
+  onlyFetchOnDemand() {
+    return this.fetchOnDemand;
+  }
   async fetchByEmojiId(emojiId, optimistic) {
     // Check if repository exists and emoji is defined.
     if (this.isLoaded() && this.isRepositoryAvailable(this.emojiRepository)) {

package/dist/es2019/context/EmojiContextProvider.js

@@ -15,7 +15,14 @@ export const EmojiContextProvider = ({
         debug('fetchEmojiProvider error catched from outside', error);
       }
     }
-    fetchEmojiProvider();
+    if (memoizedEmojiContextValue !== null && memoizedEmojiContextValue !== void 0 && memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand) {
+      const isFetchingOnDemand = memoizedEmojiContextValue === null || memoizedEmojiContextValue === void 0 ? void 0 : memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand();
+      if (!isFetchingOnDemand) {
+        fetchEmojiProvider();
+      }
+    } else {
+      fetchEmojiProvider();
+    }
   }, [memoizedEmojiContextValue]);
   return /*#__PURE__*/React.createElement(EmojiContext.Provider, {
     value: memoizedEmojiContextValue

package/dist/es2019/util/analytics/analytics.js

@@ -7,7 +7,7 @@ const createEvent = (eventType, action, actionSubject, actionSubjectId, attribut
   actionSubjectId,
   attributes: {
     packageName: "@atlaskit/emoji",
-    packageVersion: "67.4.10",
+    packageVersion: "67.5.0",
     ...attributes
   }
 });

package/dist/esm/api/EmojiResource.js

@@ -47,6 +47,7 @@ export var EmojiResource = /*#__PURE__*/function (_ref) {
     _defineProperty(_assertThisInitialized(_this), "initialLoaders", 0);
     _defineProperty(_assertThisInitialized(_this), "retries", new Map());
     _defineProperty(_assertThisInitialized(_this), "isInitialised", false);
+    _defineProperty(_assertThisInitialized(_this), "fetchOnDemand", false);
     _defineProperty(_assertThisInitialized(_this), "getOptimisticImageURL", function (emojiId) {
       if (_this.emojiProviderConfig.optimisticImageApi) {
         return _this.emojiProviderConfig.optimisticImageApi.getUrl(emojiId);
@@ -68,6 +69,7 @@ export var EmojiResource = /*#__PURE__*/function (_ref) {
     if (config.providers.length === 0) {
       throw new Error('No providers specified');
     }
+    _this.fetchOnDemand = !!config.options && !!config.options.onlyFetchOnDemand;
     _this.initialLoaders = _this.emojiProviderConfig.providers.length;
     _this.activeLoaders = _this.emojiProviderConfig.providers.length;
     _this.emojiResponses = [];
@@ -88,7 +90,7 @@ export var EmojiResource = /*#__PURE__*/function (_ref) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               options = _args.length > 0 && _args[0] !== undefined ? _args[0] : {
-                fetchAtStart: true
+                fetchAtStart: !this.fetchOnDemand
               };
               if (!options.fetchAtStart) {
                 _context.next = 11;
@@ -211,6 +213,11 @@ export var EmojiResource = /*#__PURE__*/function (_ref) {
       }
       return fetchEmojiProvider;
     }()
+  }, {
+    key: "onlyFetchOnDemand",
+    value: function onlyFetchOnDemand() {
+      return this.fetchOnDemand;
+    }
   }, {
     key: "fetchByEmojiId",
     value: function () {

package/dist/esm/context/EmojiContextProvider.js

@@ -37,7 +37,14 @@ export var EmojiContextProvider = function EmojiContextProvider(_ref) {
       }));
       return _fetchEmojiProvider.apply(this, arguments);
     }
-    fetchEmojiProvider();
+    if (memoizedEmojiContextValue !== null && memoizedEmojiContextValue !== void 0 && memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand) {
+      var isFetchingOnDemand = memoizedEmojiContextValue === null || memoizedEmojiContextValue === void 0 ? void 0 : memoizedEmojiContextValue.emoji.emojiProvider.onlyFetchOnDemand();
+      if (!isFetchingOnDemand) {
+        fetchEmojiProvider();
+      }
+    } else {
+      fetchEmojiProvider();
+    }
   }, [memoizedEmojiContextValue]);
   return /*#__PURE__*/React.createElement(EmojiContext.Provider, {
     value: memoizedEmojiContextValue

package/dist/esm/util/analytics/analytics.js

@@ -12,7 +12,7 @@ var createEvent = function createEvent(eventType, action, actionSubject, actionS
     actionSubjectId: actionSubjectId,
     attributes: _objectSpread({
       packageName: "@atlaskit/emoji",
-      packageVersion: "67.4.10"
+      packageVersion: "67.5.0"
     }, attributes)
   };
 };

package/dist/types/api/EmojiResource.d.ts

@@ -3,7 +3,7 @@ import { CategoryId } from '../components/picker/categories';
 import { EmojiDescription, EmojiId, EmojiProvider, EmojiResponse, EmojiSearchResult, EmojiUpload, OptionalEmojiDescription, OptionalEmojiDescriptionWithVariations, OptionalUser, SearchOptions, ToneSelection, UploadingEmojiProvider, User } from '../types';
 import EmojiRepository from './EmojiRepository';
 import SiteEmojiResource from './media/SiteEmojiResource';
-import { OptimisticImageApiLoaderConfig, SingleEmojiApiLoaderConfig } from './EmojiUtils';
+import { OptimisticImageApiLoaderConfig, Options, SingleEmojiApiLoaderConfig } from './EmojiUtils';
 interface GetEmojiProviderOptions {
     /**
      * Whether fetch emoji provider at start
@@ -23,6 +23,11 @@ export interface EmojiResourceConfig {
      * providers when performing shortName based look up.
      */
     providers: ServiceConfig[];
+    /**
+     * Additional configuration:
+     * * On-demand Fetching - Useful for when a product may prefer manually controlling when providers are fetched
+     */
+    options?: Options;
     /**
      * Must be set to true to enable upload support in the emoji components.
      *
@@ -80,6 +85,7 @@ export declare class EmojiResource extends AbstractResource<string, EmojiSearchR
     protected selectedTone: ToneSelection;
     protected currentUser?: User;
     protected isInitialised: boolean;
+    protected fetchOnDemand: boolean;
     protected emojiResponses: EmojiResponse[];
     emojiProviderConfig: EmojiResourceConfig;
     constructor(config: EmojiResourceConfig);
@@ -90,6 +96,7 @@ export declare class EmojiResource extends AbstractResource<string, EmojiSearchR
     getEmojiProvider(options?: GetEmojiProviderOptions): Promise<EmojiProvider>;
     private fetchIndividualProvider;
     fetchEmojiProvider(force?: boolean): Promise<EmojiRepository | undefined>;
+    onlyFetchOnDemand(): boolean;
     fetchByEmojiId(emojiId: EmojiId, optimistic: boolean): Promise<OptionalEmojiDescriptionWithVariations>;
     private getProviderType;
     protected initEmojiRepository(emojiResponses: EmojiResponse[]): void;

package/dist/types/api/EmojiUtils.d.ts

@@ -3,6 +3,9 @@ import { AltRepresentations, EmojiDescription, EmojiDescriptionWithVariations, E
 export interface EmojiLoaderConfig extends ServiceConfig {
     getRatio?: () => number;
 }
+export interface Options {
+    onlyFetchOnDemand?: boolean;
+}
 export interface SingleEmojiApiLoaderConfig extends Omit<ServiceConfig, 'url'> {
     getUrl: (emojiId: EmojiId) => string;
 }

package/dist/types/types.d.ts

@@ -121,6 +121,12 @@ export interface EmojiProvider extends Provider<string, EmojiSearchResult, any,
      * Returns a constructed URL to fetch emoji media asset if 'optimisticImageApi' config has been provided
      */
     getOptimisticImageURL(emojiId: EmojiId): string | undefined;
+    /**
+     * @return a boolean indicating whether providers should be fetched on-demand only, and automatic fetches prevented
+     *
+     * Optional.
+     */
+    onlyFetchOnDemand?(): boolean;
 }
 export interface UploadingEmojiProvider extends EmojiProvider {
     /**

package/dist/types-ts4.5/api/EmojiResource.d.ts

@@ -3,7 +3,7 @@ import { CategoryId } from '../components/picker/categories';
 import { EmojiDescription, EmojiId, EmojiProvider, EmojiResponse, EmojiSearchResult, EmojiUpload, OptionalEmojiDescription, OptionalEmojiDescriptionWithVariations, OptionalUser, SearchOptions, ToneSelection, UploadingEmojiProvider, User } from '../types';
 import EmojiRepository from './EmojiRepository';
 import SiteEmojiResource from './media/SiteEmojiResource';
-import { OptimisticImageApiLoaderConfig, SingleEmojiApiLoaderConfig } from './EmojiUtils';
+import { OptimisticImageApiLoaderConfig, Options, SingleEmojiApiLoaderConfig } from './EmojiUtils';
 interface GetEmojiProviderOptions {
     /**
      * Whether fetch emoji provider at start
@@ -23,6 +23,11 @@ export interface EmojiResourceConfig {
      * providers when performing shortName based look up.
      */
     providers: ServiceConfig[];
+    /**
+     * Additional configuration:
+     * * On-demand Fetching - Useful for when a product may prefer manually controlling when providers are fetched
+     */
+    options?: Options;
     /**
      * Must be set to true to enable upload support in the emoji components.
      *
@@ -80,6 +85,7 @@ export declare class EmojiResource extends AbstractResource<string, EmojiSearchR
     protected selectedTone: ToneSelection;
     protected currentUser?: User;
     protected isInitialised: boolean;
+    protected fetchOnDemand: boolean;
     protected emojiResponses: EmojiResponse[];
     emojiProviderConfig: EmojiResourceConfig;
     constructor(config: EmojiResourceConfig);
@@ -90,6 +96,7 @@ export declare class EmojiResource extends AbstractResource<string, EmojiSearchR
     getEmojiProvider(options?: GetEmojiProviderOptions): Promise<EmojiProvider>;
     private fetchIndividualProvider;
     fetchEmojiProvider(force?: boolean): Promise<EmojiRepository | undefined>;
+    onlyFetchOnDemand(): boolean;
     fetchByEmojiId(emojiId: EmojiId, optimistic: boolean): Promise<OptionalEmojiDescriptionWithVariations>;
     private getProviderType;
     protected initEmojiRepository(emojiResponses: EmojiResponse[]): void;

package/dist/types-ts4.5/api/EmojiUtils.d.ts

@@ -3,6 +3,9 @@ import { AltRepresentations, EmojiDescription, EmojiDescriptionWithVariations, E
 export interface EmojiLoaderConfig extends ServiceConfig {
     getRatio?: () => number;
 }
+export interface Options {
+    onlyFetchOnDemand?: boolean;
+}
 export interface SingleEmojiApiLoaderConfig extends Omit<ServiceConfig, 'url'> {
     getUrl: (emojiId: EmojiId) => string;
 }

package/dist/types-ts4.5/types.d.ts

@@ -121,6 +121,12 @@ export interface EmojiProvider extends Provider<string, EmojiSearchResult, any,
      * Returns a constructed URL to fetch emoji media asset if 'optimisticImageApi' config has been provided
      */
     getOptimisticImageURL(emojiId: EmojiId): string | undefined;
+    /**
+     * @return a boolean indicating whether providers should be fetched on-demand only, and automatic fetches prevented
+     *
+     * Optional.
+     */
+    onlyFetchOnDemand?(): boolean;
 }
 export interface UploadingEmojiProvider extends EmojiProvider {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/emoji",
-  "version": "67.4.10",
+  "version": "67.5.0",
   "description": "Fabric emoji React components",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -34,7 +34,7 @@
   },
   "dependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
-    "@atlaskit/button": "^16.9.0",
+    "@atlaskit/button": "^16.10.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/media-client": "^24.0.0",
     "@atlaskit/spinner": "^15.5.0",

package/report.api.md

@@ -291,6 +291,7 @@ export interface EmojiProvider
     emoji: EmojiDescription,
     useAlt?: boolean,
   ): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+  onlyFetchOnDemand?(): boolean;
   optimisticMediaRendering(emoji: EmojiDescription, useAlt?: boolean): boolean;
   recordSelection?(emoji: EmojiDescription): Promise<any>;
   setSelectedTone(tone: ToneSelection): void;
@@ -384,6 +385,8 @@ class EmojiResource_2
   // (undocumented)
   fetchEmojiProvider(force?: boolean): Promise<EmojiRepository | undefined>;
   // (undocumented)
+  protected fetchOnDemand: boolean;
+  // (undocumented)
   filter(query?: string, options?: SearchOptions): void;
   // (undocumented)
   findByEmojiId(
@@ -438,6 +441,8 @@ class EmojiResource_2
   // (undocumented)
   protected notifyResult(result: EmojiSearchResult): void;
   // (undocumented)
+  onlyFetchOnDemand(): boolean;
+  // (undocumented)
   optimisticMediaRendering(emoji: EmojiDescription, useAlt?: boolean): boolean;
   // (undocumented)
   protected recordConfig?: ServiceConfig;
@@ -461,6 +466,7 @@ export interface EmojiResourceConfig {
   allowUpload?: boolean;
   currentUser?: User;
   optimisticImageApi?: OptimisticImageApiLoaderConfig;
+  options?: Options;
   providers: ServiceConfig[];
   recordConfig?: ServiceConfig;
   singleEmojiApi?: SingleEmojiApiLoaderConfig;
@@ -978,6 +984,12 @@ export type OptionalEmojiDescriptionWithVariations =
 // @public (undocumented)
 export type OptionalUser = User | undefined;
 
+// @public (undocumented)
+interface Options {
+  // (undocumented)
+  onlyFetchOnDemand?: boolean;
+}
+
 // @public (undocumented)
 interface PickerRefHandler {
   // (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -229,6 +229,7 @@ export interface EmojiProvider extends Provider<string, EmojiSearchResult, any,
     getOptimisticImageURL(emojiId: EmojiId): string | undefined;
     getSelectedTone(): ToneSelection;
     loadMediaEmoji(emoji: EmojiDescription, useAlt?: boolean): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
+    onlyFetchOnDemand?(): boolean;
     optimisticMediaRendering(emoji: EmojiDescription, useAlt?: boolean): boolean;
     recordSelection?(emoji: EmojiDescription): Promise<any>;
     setSelectedTone(tone: ToneSelection): void;
@@ -300,6 +301,8 @@ class EmojiResource_2 extends AbstractResource<string, EmojiSearchResult, any, u
     // (undocumented)
     fetchEmojiProvider(force?: boolean): Promise<EmojiRepository | undefined>;
     // (undocumented)
+    protected fetchOnDemand: boolean;
+    // (undocumented)
     filter(query?: string, options?: SearchOptions): void;
     // (undocumented)
     findByEmojiId(emojiId: EmojiId): OptionalEmojiDescription | Promise<OptionalEmojiDescription>;
@@ -338,6 +341,8 @@ class EmojiResource_2 extends AbstractResource<string, EmojiSearchResult, any, u
     // (undocumented)
     protected notifyResult(result: EmojiSearchResult): void;
     // (undocumented)
+    onlyFetchOnDemand(): boolean;
+    // (undocumented)
     optimisticMediaRendering(emoji: EmojiDescription, useAlt?: boolean): boolean;
     // (undocumented)
     protected recordConfig?: ServiceConfig;
@@ -361,6 +366,7 @@ export interface EmojiResourceConfig {
     allowUpload?: boolean;
     currentUser?: User;
     optimisticImageApi?: OptimisticImageApiLoaderConfig;
+    options?: Options;
     providers: ServiceConfig[];
     recordConfig?: ServiceConfig;
     singleEmojiApi?: SingleEmojiApiLoaderConfig;
@@ -855,6 +861,12 @@ export type OptionalEmojiDescriptionWithVariations = EmojiDescriptionWithVariati
 // @public (undocumented)
 export type OptionalUser = User | undefined;
 
+// @public (undocumented)
+interface Options {
+    // (undocumented)
+    onlyFetchOnDemand?: boolean;
+}
+
 // @public (undocumented)
 interface PickerRefHandler {
     // (undocumented)