@enplug/sdk-dashboard - npm Package Compare versions

Comparing version 5.2.2-zoning-3 to 5.2.2-zoning-4

package.json

 {
   "name": "@enplug/sdk-dashboard",
-  "version": "5.2.2-zoning-3",
+  "version": "5.2.2-zoning-4",
   "description": "Enplug Dashboard SDK",
@@ -5,0 +5,0 @@ "main": "./src/index.ts",

src/account.ts

@@ -328,3 +328,3 @@ import {
     validateString(widgetAppId, 'You must provide an widgetAppId parameter');
-    validateString(slotConfig, 'You must provide an slotConfig parameter');
+    validateObject(slotConfig, 'You must provide an slotConfig parameter');
 
@@ -331,0 +331,0 @@ return this.bridge.sendMessage({

src/dashboard.ts

@@ -15,2 +15,3 @@ import {
   AssetPreviewRequest,
+  AssetPreviewData,
 } from '../types/external-types';
@@ -122,2 +123,3 @@ import { BridgeBase } from './bridge/bridge-base';
   /**
+   * @deprecated use `navigateToZoning()`
    * Navigate back from widget.
@@ -130,9 +132,10 @@ * @param {string} assetId Id of an asset to which to go back to.
       name: MessageNames.NavigateBack,
-      params: {
-        assetId,
-      },
+      params: { assetId },
     });
   }
 
-  // TODO
+  /**
+   * Navigate back to zoning from widget.
+   * assetId is optional, fallback parameter for v1->v2 transition phase
+   */
   navigateToZoning(assetId?: string): Promise<any> {
@@ -209,2 +212,3 @@ return this.bridge.sendMessage({
   /**
+   * @deprecated use `previewAsset()`
    * Opens app preview modal.
@@ -237,3 +241,3 @@ * @param {string} url
   /**
-   * todo
+   * Opens app asset preview modal.
    */
@@ -250,10 +254,12 @@ previewAsset<TAssetValue = any, TThemeValue = any, TFeedType = any>(
 
+  // tslint:disable
   /**
-   * todo
+   * Get preview params for an app asset for custom preview handling
+   * @param appId
+   * @param asset
+   * @param origin (default: true) - custom origin url, when omitted or falsy, `window.location.origin` will be attached
    */
-  getAssetPreviewData(appId: string, asset: Asset<any>, origin: string)
-    : Promise<{
-      previewType: 'app' | 'graphics' | 'video' | 'url',
-      previewUrl: string, theme: any, feedData: any, locale: string,
-    }> {
+  // tslint:enable
+  getAssetPreviewData(appId: string, asset: Asset<any>, origin?: string | boolean)
+    : Promise<AssetPreviewData> {
     validateString(appId, 'appId must be a string.');
@@ -260,0 +266,0 @@ validateObject(asset, 'asset must be an instance of Asset<any>.');

types/external-types.ts

@@ -43,9 +43,10 @@ /** These are meant to avaialable to client apps */
 
+  /** readonly flag */
   IsZoningWidget?: boolean;
 
   /** Currently @ Value.Name - subject to change. Display name of the asset. used in lists. */
-  Name?: string;
+  // Name?: string;
 
   /** Currently @ Value.Zone - subject to change. Zoning widget asset slot type */
-  Zone?: 'banner' | 'ticker' | 'elevator';
+  // Zone?: 'banner' | 'ticker' | 'elevator';
 
@@ -208,7 +209,8 @@ /** List of zoning assets on which the obj - a widget asset is placed */
 export interface AssetPreviewRequest<TAssetValue, TThemeValue, TFeedType> {
-  url?: string; // ? is ignored anyways
   asset: Asset<TAssetValue>;
   theme?: ThemeAsset<TThemeValue>;
   feedData?: FeedData<TFeedType>;
+  /** incompatible with `zoningConfig`. Pass `layout` for regular asset preview */
   layout?: Layout;
+  /** incompatible with `layout`. Pass `zoningConfig` for zoning widget asset preview */
   zoningConfig?: ZoningConfig;
@@ -428,2 +430,4 @@ }
   showDeployDialog?: boolean;
+
+  /** content approval  */
   noDialog?: boolean;
@@ -594,1 +598,16 @@
 }
+
+export type AssetPreviewType = 'graphics' | 'video' | 'url' | 'app';
+export interface AssetPreviewApp {
+  AppId: string;
+  AppUrl: string;
+  Name: string;
+}
+export interface AssetPreviewData {
+  app: AssetPreviewApp;
+  previewType: AssetPreviewType;
+  previewUrl: string;
+  theme: any;
+  feedData: any;
+  locale: string;
+}

No alert changes

Improved metrics

Total package byte prevSize

223097

increased by0.82%

Lines of code

3554

increased by0.88%

No dependency changes