@enplug/sdk-dashboard 5.4.0 → 5.4.2-2.1-dev

package/types/index.ts

@@ -1,2 +1,2 @@
-export * from './external-types';
-export * from './sdk';
+export * from './external-types';
+export * from './sdk';

package/types/internal-types.d.ts

@@ -1,161 +1,167 @@
-/**
- * Internal types, not to be re-exported.
- */
-export interface InboundMessage {
-    /**
-     * Namespace of the event.
-     */
-    namespace: string;
-    /**
-     * Whether the request was a successful one.
-     */
-    success: boolean;
-    /**
-     * An id of the call.
-     */
-    callId: number;
-    /**
-     * Data returned by the dashboard. Type depends on the call type.
-     */
-    data?: string;
-}
-export interface OutboundMessage {
-    /**
-     * An id of the call. Gets incremented with every sent message.
-     * Used internally to match responses to their respective calls.
-     */
-    callId?: number;
-    /**
-     * The namespace that the event belongs to.
-     */
-    namespace: string;
-    /**
-     * Name of the event.
-     */
-    name: string;
-    /**
-     * Id of an app that the request concerns.
-     */
-    appId?: string;
-    /**
-     * Parameters of the call. Abitrary, depend on a call.
-     */
-    params?: any;
-    /**
-     * For the calls that expect multiple responses.
-     */
-    persistent?: boolean;
-    /**
-     * A callback that persistent messages will call every time their response comes.
-     */
-    callback?: (...args: any[]) => void;
-    /**
-     * For the calls that expect no responses.
-     */
-    transient?: boolean;
-}
-export interface PendingCallInfo {
-    /**
-     * A method to resolve call's promise.
-     */
-    resolve: (...args: any[]) => any;
-    /**
-     * A method to reject call's promise.
-     */
-    reject: (...args: any[]) => any;
-    /**
-     * A flag indicating whether the SDK should stop listening for more responses after the first arrives.
-     */
-    persistent: boolean;
-}
-export declare enum MessageNamespaces {
-    App = "app",
-    Social = "social",
-    Dashboard = "dashboard"
-}
-export declare enum MessageNames {
-    GetAccount = "app.getAccount",
-    GetUser = "app.getUser",
-    GetDisplayGroups = "app.getDisplays",
-    GetSelectedDisplayId = "app.getSelectedDisplayId",
-    GetAssets = "app.getAssets",
-    GetAssetsByIds = "app.getAssetsByIds",
-    GetAssetsForApp = "app.getAssetsForApp",
-    GetAssetRevision = "app.getAssetRevision",
-    BulkCreateAssets = "app.bulkCreateAssets",
-    BulkDeployAssets = "app.bulkDeployAssets",
-    SaveAsset = "app.saveAsset",
-    UpdateAssetOrder = "app.updateAssetOrder",
-    DeleteAsset = "app.deleteAsset",
-    TouchAsset = "app.touchAsset",
-    GetAssetNeedsApproval = "app.getAssetNeedsApproval",
-    GetDefaultAssets = "app.getDefaultAssets",
-    GetZoningApps = "app.getZoningApps",
-    AcquireZoningWidget = "app.acquireZoningWidget",
-    GetZoningData = "app.getZoningData",
-    EditZoningWidget = "app.editZoningWidget",
-    GetZoningLayoutAssets = "app.getZoningLayoutAssets",
-    GetFonts = "app.getFonts",
-    GetThemes = "app.getThemes",
-    GetTheme = "app.getTheme",
-    EditTheme = "app.editTheme",
-    SaveTheme = "app.saveTheme",
-    DeleteTheme = "app.deleteTheme",
-    HasFeatureFlag = "app.hasFeatureFlag",
-    GetDisplayGroupCustomProperties = "app.getDisplayGroupCustomProperties",
-    AppUrlChanged = "app.appUrlChanged",
-    Click = "dashboard.click",
-    ConfirmUnsavedChanges = "dashboard.unsavedChanges",
-    ErrorIndicator = "dashboard.indicator.error",
-    LoadingIndicator = "dashboard.indicator.loading",
-    Navigate = "dashboard.navigate",
-    NavigateBack = "dashboard.navigateBack",
-    NavigateToZoning = "dashboard.navigateToZoning",
-    NavigateToUrl = "dashboard.navigateToUrl",
-    OpenConfirm = "dashboard.confirm",
-    PageError = "dashboard.page.error",
-    PageLoading = "dashboard.page.loading",
-    PageNotFound = "dashboard.page.notFound",
-    Preview = "dashboard.preview",
-    GetAssetPreviewData = "dashboard.getAssetPreviewData",
-    PreviewAsset = "dashboard.previewAsset",
-    SetDisplaySelectorCallback = "dashboard.set.selectorCallback",
-    SetDisplaySelectorVisibility = "dashboard.set.selectorEnabled",
-    SetHeaderButtons = "dashboard.set.buttons",
-    SetHeaderTitle = "dashboard.set.title",
-    SuccessIndicator = "dashboard.indicator.success",
-    SwitchToView = "dashboard.switchToView",
-    Upload = "dashboard.upload",
-    ConnectData = "dashboard.connectData",
-    EditDataConnection = "dashboard.editDataConnection",
-    ProcessAssetResource = "dashboard.processAssetResource",
-    EncodeStatus = "dashboard.encodeStatus",
-    ResourcesEncodingStatus = "dashboard.resourcesEncodingStatus",
-    OpenContentIntervalSettingsDialog = "dashboard.openContentIntervalSettingsDialog",
-    SetAppHasUnsavedChanges = "dashboard.appHasUnsavedChanges",
-    ClearQueryString = "social.clearQueryString",
-    AuthInstagram = "social.authInstagram",
-    AuthSlack = "social.authSlack",
-    AuthenticateSlack = "social.authenticateSlack",
-    AuthenticateTeamsUser = "social.authenticateTeamsUser",
-    AuthenticateTeamsAdmin = "social.authenticateTeamsAdmin",
-    GetInstagramAccounts = "social.getInstagramAccounts",
-    TwitterSubscriptionStatus = "social.twitterSubscriptionStatus",
-    LookupTwitterId = "social.lookupTwitterId",
-    GetSlackTeams = "social.getSlackTeams",
-    GetSlackChannels = "social.getSlackChannels",
-    GetTeamsChannels = "social.getTeamsChannels",
-    AddFacebookPage = "social.addFacebookPage",
-    GetFeeds = "social.getFeeds",
-    SaveFeed = "social.saveFeed",
-    DeleteFeed = "social.deleteFeed",
-    OpenPreapprovalDialog = "social.openPreapprovalDialog",
-    LoadAllItems = "social.loadAllItems",
-    ApproveItem = "social.approveItem",
-    RemoveItem = "social.removeItem",
-    FavoriteItem = "social.favoriteItem",
-    UnfavoriteItem = "social.unfavoriteItem",
-    BanItem = "social.banItem",
-    LoadBlacklist = "social.loadBlacklist",
-    UnbanUser = "social.unbanUser"
-}
+/**
+ * Internal types, not to be re-exported.
+ */
+export interface InboundMessage {
+    /**
+     * Namespace of the event.
+     */
+    namespace: string;
+    /**
+     * Whether the request was a successful one.
+     */
+    success: boolean;
+    /**
+     * An id of the call.
+     */
+    callId: number;
+    /**
+     * Data returned by the dashboard. Type depends on the call type.
+     */
+    data?: string;
+}
+export interface OutboundMessage {
+    /**
+     * An id of the call. Gets incremented with every sent message.
+     * Used internally to match responses to their respective calls.
+     */
+    callId?: number;
+    /**
+     * The namespace that the event belongs to.
+     */
+    namespace: string;
+    /**
+     * Name of the event.
+     */
+    name: string;
+    /**
+     * Id of an app that the request concerns.
+     */
+    appId?: string;
+    /**
+     * Parameters of the call. Abitrary, depend on a call.
+     */
+    params?: any;
+    /**
+     * For the calls that expect multiple responses.
+     */
+    persistent?: boolean;
+    /**
+     * A callback that persistent messages will call every time their response comes.
+     */
+    callback?: (...args: any[]) => void;
+    /**
+     * For the calls that expect no responses.
+     */
+    transient?: boolean;
+}
+export interface PendingCallInfo {
+    /**
+     * A method to resolve call's promise.
+     */
+    resolve: (...args: any[]) => any;
+    /**
+     * A method to reject call's promise.
+     */
+    reject: (...args: any[]) => any;
+    /**
+     * A flag indicating whether the SDK should stop listening for more responses after the first arrives.
+     */
+    persistent: boolean;
+}
+export declare enum MessageNamespaces {
+    App = "app",
+    Social = "social",
+    Dashboard = "dashboard"
+}
+export declare enum MessageNames {
+    GetAccount = "app.getAccount",
+    GetUser = "app.getUser",
+    GetDisplayGroups = "app.getDisplays",
+    GetSelectedDisplayId = "app.getSelectedDisplayId",
+    GetAssets = "app.getAssets",
+    GetAssetsByIds = "app.getAssetsByIds",
+    GetAssetsForApp = "app.getAssetsForApp",
+    GetAssetRevision = "app.getAssetRevision",
+    BulkCreateAssets = "app.bulkCreateAssets",
+    BulkDeployAssets = "app.bulkDeployAssets",
+    SaveAsset = "app.saveAsset",
+    UpdateAssetOrder = "app.updateAssetOrder",
+    DeleteAsset = "app.deleteAsset",
+    TouchAsset = "app.touchAsset",
+    GetAssetNeedsApproval = "app.getAssetNeedsApproval",
+    GetDefaultAssets = "app.getDefaultAssets",
+    GetZoningApps = "app.getZoningApps",
+    AcquireZoningWidget = "app.acquireZoningWidget",
+    GetZoningData = "app.getZoningData",
+    EditZoningWidget = "app.editZoningWidget",
+    GetZoningLayoutAssets = "app.getZoningLayoutAssets",
+    GetFonts = "app.getFonts",
+    GetThemes = "app.getThemes",
+    GetTheme = "app.getTheme",
+    EditTheme = "app.editTheme",
+    SaveTheme = "app.saveTheme",
+    DeleteTheme = "app.deleteTheme",
+    HasFeatureFlag = "app.hasFeatureFlag",
+    GetDisplayGroupCustomProperties = "app.getDisplayGroupCustomProperties",
+    AppUrlChanged = "app.appUrlChanged",
+    LoadAccount = "app.loadAccount",
+    Click = "dashboard.click",
+    ConfirmUnsavedChanges = "dashboard.unsavedChanges",
+    ErrorIndicator = "dashboard.indicator.error",
+    LoadingIndicator = "dashboard.indicator.loading",
+    NavigateToZoning = "dashboard.navigateToZoning",
+    NavigateToUrl = "dashboard.navigateToUrl",
+    OpenConfirm = "dashboard.confirm",
+    PageError = "dashboard.page.error",
+    PageLoading = "dashboard.page.loading",
+    PageNotFound = "dashboard.page.notFound",
+    Preview = "dashboard.preview",
+    GetAssetPreviewData = "dashboard.getAssetPreviewData",
+    PreviewAsset = "dashboard.previewAsset",
+    SetDisplaySelectorCallback = "dashboard.set.selectorCallback",
+    SetDisplaySelectorVisibility = "dashboard.set.selectorEnabled",
+    SetHeaderButtons = "dashboard.set.buttons",
+    SetHeaderTitle = "dashboard.set.title",
+    SuccessIndicator = "dashboard.indicator.success",
+    SwitchToView = "dashboard.switchToView",
+    Upload = "dashboard.upload",
+    ConnectData = "dashboard.connectData",
+    EditDataConnection = "dashboard.editDataConnection",
+    EncodeStatus = "dashboard.encodeStatus",
+    ResourcesEncodingStatus = "dashboard.resourcesEncodingStatus",
+    OpenContentIntervalSettingsDialog = "dashboard.openContentIntervalSettingsDialog",
+    SetAppHasUnsavedChanges = "dashboard.appHasUnsavedChanges",
+    ClearQueryString = "social.clearQueryString",
+    AuthInstagram = "social.authInstagram",
+    AuthSlack = "social.authSlack",
+    AuthenticateSlack = "social.authenticateSlack",
+    AuthenticateTeamsUser = "social.authenticateTeamsUser",
+    AuthenticateTeamsAdmin = "social.authenticateTeamsAdmin",
+    GetInstagramAccounts = "social.getInstagramAccounts",
+    TwitterSubscriptionStatus = "social.twitterSubscriptionStatus",
+    LookupTwitterId = "social.lookupTwitterId",
+    GetSlackTeams = "social.getSlackTeams",
+    GetSlackChannels = "social.getSlackChannels",
+    GetTeamsChannels = "social.getTeamsChannels",
+    AddFacebookPage = "social.addFacebookPage",
+    GetFeeds = "social.getFeeds",
+    SaveFeed = "social.saveFeed",
+    DeleteFeed = "social.deleteFeed",
+    OpenPreapprovalDialog = "social.openPreapprovalDialog",
+    LoadAllItems = "social.loadAllItems",
+    ApproveItem = "social.approveItem",
+    RemoveItem = "social.removeItem",
+    FavoriteItem = "social.favoriteItem",
+    UnfavoriteItem = "social.unfavoriteItem",
+    BanItem = "social.banItem",
+    LoadBlacklist = "social.loadBlacklist",
+    UnbanUser = "social.unbanUser",
+    RefreshFeed = "social.refreshFeed",
+    CreateAssetVersion = "app.createAssetVersion",
+    GetAssetsHistoryById = "app.getAssetsHistoryById",
+    GetAssetsHistoryByAssetId = "app.getAssetsHistoryByAssetId",
+    DeleteAssetHistory = "app.deleteAssetHistory",
+    RestoreVersion = "app.restoreVersion",
+    RefreshTwitterFeed = "social.refreshTwitterFeed",
+    CloseWindow = "dashboard.closeWindow"
+}

package/types/sdk.d.ts

@@ -1,8 +1,8 @@
-import { Account } from './account';
-import { Dashboard } from './dashboard';
-import { Social } from './social';
-export interface EnplugDashboardSDK {
-    account: Account;
-    dashboard: Dashboard;
-    social: Social;
-}
+import { Account } from './account';
+import { Dashboard } from './dashboard';
+import { Social } from './social';
+export interface EnplugDashboardSDK {
+    account: Account;
+    dashboard: Dashboard;
+    social: Social;
+}

package/types/social.d.ts

@@ -1,39 +1,52 @@
-import { BridgeBase } from './bridge/bridge-base';
-import { PreapprovalDialogOptions, SocialItemsResponse, TwitterSubscriptionStatusResponse } from './external-types';
-export declare class Social {
-    private bridge;
-    constructor(bridge: BridgeBase);
-    clearQueryString(): Promise<any>;
-    authInstagram(accessToken: string): Promise<any>;
-    authSlack(verificationCode: string, redirectUrl: string): Promise<any>;
-    authenticateSlack(verificationCode: string, redirectUrl: string): Promise<any>;
-    authenticateTeamsUser(verificationCode: string, redirectUrl: string): Promise<any>;
-    /**
-     * Saves Teams Admin token to backend.
-     * @param tenantId A user id returned from MS Teams after authenticating.
-     */
-    authenticateTeamsAdmin(tenantId: string): Promise<any>;
-    getInstagramAccounts(userId: string): Promise<any>;
-    lookupTwitterId(username: string): Promise<any>;
-    twitterSubscriptionStatus(): Promise<TwitterSubscriptionStatusResponse>;
-    getSlackTeams(): Promise<any>;
-    getSlackChannels(teamId: string): Promise<any>;
-    /**
-     * Returns Channels available for a given user id
-     * @param tenantId An ID returned after authenticating the user with MS Teams
-     */
-    getTeamsChannels(tenantId: string): Promise<any>;
-    addFacebookPage(feedId: string, pageId: string, accessToken: string): Promise<any>;
-    getFeeds(assetId: string): Promise<any>;
-    saveFeed(feed: any): Promise<any>;
-    deleteFeed(feedId: string): Promise<any>;
-    openPreapprovalDialog(feed: any, iconUrl: string, options?: PreapprovalDialogOptions): Promise<any>;
-    loadAllItems(assetId: string): Promise<SocialItemsResponse>;
-    approveItem(itemId: string, assetId: string): Promise<any>;
-    removeItem(itemId: string, assetId: string): Promise<any>;
-    favoriteItem(itemId: string, assetId: string, network: string): Promise<void>;
-    unfavoriteItem(itemId: string, assetId: string, network: string): Promise<any>;
-    banItem(itemId: string, assetId: string): Promise<any>;
-    loadBlacklist(accountId: string, socialNetwork: string): Promise<any>;
-    unbanUser(username: string, socialNetwork: string, accountId: string): Promise<any>;
-}
+import { BridgeBase } from './bridge/bridge-base';
+import { PreapprovalDialogOptions, SocialItemsResponse, TwitterSubscriptionStatusResponse } from './external-types';
+/**
+ * Social API is a part of the Dashboard SDK used to access social media related data.
+ * Use global `enplug.social` object to access these methods.
+ */
+export declare class Social {
+    private bridge;
+    /** @internal */
+    constructor(bridge: BridgeBase);
+    clearQueryString(): Promise<any>;
+    authInstagram(accessToken: string): Promise<any>;
+    authSlack(verificationCode: string, redirectUrl: string): Promise<any>;
+    authenticateSlack(verificationCode: string, redirectUrl: string): Promise<any>;
+    authenticateTeamsUser(verificationCode: string, redirectUrl: string): Promise<any>;
+    /**
+     * Saves Teams Admin token to backend.
+     * @param tenantId - A user id returned from MS Teams after authenticating.
+     */
+    authenticateTeamsAdmin(tenantId: string): Promise<any>;
+    getInstagramAccounts(userId: string): Promise<any>;
+    lookupTwitterId(username: string): Promise<any>;
+    twitterSubscriptionStatus(): Promise<TwitterSubscriptionStatusResponse>;
+    getSlackTeams(): Promise<any>;
+    getSlackChannels(teamId: string): Promise<any>;
+    /**
+     * Returns Channels available for a given user ID.
+     * @param tenantId - An ID returned after authenticating the user with MS Teams.
+     */
+    getTeamsChannels(tenantId: string): Promise<any>;
+    addFacebookPage(feedId: string, pageId: string, accessToken: string): Promise<any>;
+    getFeeds(assetId: string): Promise<any>;
+    saveFeed(feed: any): Promise<any>;
+    deleteFeed(feedId: string): Promise<any>;
+    openPreapprovalDialog(feed: any, iconUrl: string, options?: PreapprovalDialogOptions): Promise<any>;
+    loadAllItems(assetId: string): Promise<SocialItemsResponse>;
+    approveItem(itemId: string, assetId: string): Promise<any>;
+    removeItem(itemId: string, assetId: string): Promise<any>;
+    favoriteItem(itemId: string, assetId: string, network: string): Promise<void>;
+    unfavoriteItem(itemId: string, assetId: string, network: string): Promise<any>;
+    banItem(itemId: string, assetId: string): Promise<any>;
+    loadBlacklist(accountId: string, socialNetwork: string): Promise<any>;
+    unbanUser(username: string, socialNetwork: string, accountId: string): Promise<any>;
+    /**
+     * Gets new Facebook posts
+     */
+    refreshFeed(feedId: string): Promise<any>;
+    /**
+    * Gets new Twitter posts
+    */
+    refreshTwitterFeed(assetId: string, feedId: string): Promise<any>;
+}

package/types/utils.d.ts

@@ -1,5 +1,5 @@
-export declare function validateArray(arg: any, message: string): void;
-export declare function validateString(arg: any, message: string): void;
-export declare function validateObject(arg: any, message: string): void;
-export declare function validateBool(arg: any, message: string): void;
-export declare function validateFunction(arg: any, message: any): void;
+export declare function validateArray(arg: any, message: string): void;
+export declare function validateString(arg: any, message: string): void;
+export declare function validateObject(arg: any, message: string): void;
+export declare function validateBool(arg: any, message: string): void;
+export declare function validateFunction(arg: any, message: any): void;