@spiffcommerce/core 21.8.2 → 21.9.0-alpha.1

package/dist/index.d.ts

@@ -1093,14 +1093,23 @@ interface AssetManager {
      * Uploads a file to the Spiff Commerce Platform.
      */
     uploadFile: (file: File, onProgress: (val: number) => void) => Promise<Asset>;
+    /**
+     * From an existing asset, generates a new asset that has the background replaced with transparency.
+     * This process is idempotent, i.e. it will only run once for a given asset.
+     * @param asset The existing asset to remove the background from.
+     * @returns A promise that resolves with a new asset.
+     */
+    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
 }
 declare class AssetService implements AssetManager {
     private cache;
+    private bgrmCache;
     private materialCache;
     /**
      * Allows for retrieving an asset, returns the option from a cache if possible.
      */
     getLocalOrFromServer(assetKey: string): Promise<Asset>;
+    getOriginalFile(asset: Asset): Promise<Asset>;
     /**
      * Caches an asset if it doesn't already exist.
      */
@@ -1110,7 +1119,7 @@ declare class AssetService implements AssetManager {
      */
     cacheMaterial(material: MaterialResource): void;
     /**
-     * Allows for retrieving amaterial, returns the option from a cache if possible.
+     * Allows for retrieving a material, returns the option from a cache if possible.
      * @param id The option ID to be retrieved.
      */
     getMaterialLocalOrFromServer(id: string): Promise<MaterialResource>;
@@ -1119,7 +1128,9 @@ declare class AssetService implements AssetManager {
      * The asset will be stored via the persistence service for future access, if available.
      */
     uploadAssetWithProgress(file: FileInfo, assetType: AssetType, onProgress: (val: number) => void, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
+    uploadAsset(file: FileInfo, assetType: AssetType, anonymous?: boolean, temporary?: boolean): Promise<Asset>;
     uploadFile(file: File, onProgress: (val: number) => void): Promise<Asset>;
+    removeBackgroundFromAsset(asset: Asset): Promise<Asset>;
     removePersistedAsset(assetKey: string): void;
     getPersistedAssets(): PersistedAsset[];
     /**
@@ -1132,6 +1143,7 @@ declare class AssetService implements AssetManager {
      * @param assetType The type of asset we're expecting to upload
      */
     private dispatchCreateAssetRequest;
+    private removeBackground;
     private guessMIME;
 }
 interface PersistedAsset {