@ichicraft/widgets-widget-base 1.8.12 → 1.8.14

package/lib/types/index.d.ts

@@ -1,647 +1,646 @@
-/**
- * Widget context providing widget metadata and functionality offered by the widget board
- */
-export interface WidgetContext {
-    /**
-     * metadata and functions in the context of a widget instance. A widget instance
-     * is a single and specific widget that a user has on his/her board. It has its own
-     * unique ID and possibly configuration data if the widget is configurable by the user
-     */
-    instance: {
-        /**
-         * Unique id for a specific widget on a user's board
-         */
-        id: string;
-        /**
-         * Optional configuration data that contains user settings of a specific widget instance
-         */
-        data?: string;
-        /**
-         * The type of board this widget instance is added to.
-         */
-        boardType?: BoardType;
-        /**
-         * Call this function from within a widget instance to publish a notification to the
-         * notitication box on top of the widget board. It should provide information for this specific
-         * widget instance. Notitifcation content is limited to one single line and a widget instance
-         * can only have one active notification at a time
-         */
-        publishNotification?: (content: string, expirationDateTime: Date) => void;
-        /**
-         * Call this function to open the widget configuration panel for a user. This is an additional
-         * way to open the panel because a user can also open the configuration panel by using the contextual
-         * menu of the widget.
-         */
-        openConfiguration?: () => void;
-        /**
-         * Call this function to open the widget delete confirmation dialog for a user. This offers widget developers
-         * the ability to trigger the "widget deletion process". This allows different methods to delete the widget.
-         */
-        initiateWidgetDeletion?: () => void;
-        /**
-         * Functionality offered by the widget board to change the title of the widget.
-         */
-        setWidgetTitle?: (title: string) => void;
-        /**
-         * Functionality offered by the widget board to append the title of the widget with additional text.
-         */
-        setWidgetTitleSuffix?: (suffix: string) => void;
-        /**
-         * Functionality offered by the widget board to change the subtitle of the widget.
-         */
-        setWidgetSubtitle?: (subtitle: string) => void;
-        /**
-         * Show or hide the header of the widget, allowing widgets to take control of full widget real estate.
-         */
-        setWidgetHeaderVisibility?: (visible: boolean) => void;
-        /**
-         * Show or hide the settings button of the widget.
-         */
-        setUserConfigButtonVisibility?: (visible: boolean) => void;
-        /**
-         * Optional callback to handle the click event of the widget title.
-         */
-        onWidgetTitleClicked?: () => void;
-        /**
-         * Allows registration of multiple custom command bar items which can either result in an icon or
-         * an icon button, depending on the presence of the onClick property. To remove the items,
-         * use the [unregisterCommandBarItems] function.
-         */
-        registerCustomCommandBarItems?: (props: CustomCommandBarItemProps[]) => void;
-        /**
-         * Allows registration of a custom command bar item which can either result in an icon or
-         * an icon button, depending on the presence of the onClick property. To remove the item,
-         * use the [unregisterCommandBarItem] function.
-         */
-        registerCustomCommandBarItem?: (props: CustomCommandBarItemProps) => void;
-        /**
-         * Removes all registered custom command bar items.
-         */
-        unregisterCustomCommandBarItems?: () => void;
-        /**
-         * Removes a single custom command bar item, corresponding to the provided id.
-         * If no id was specified, it removes all items.
-         */
-        unregisterCustomCommandBarItem?: (id?: string) => void;
-        /**
-         * Raises an event to be handled by the Time-based Events feature of Ichicraft Boards.
-         * @param object The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
-         * @param action The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
-         * @param data Optionally provide extra metadata to be included with the raised event.
-         * widgetAlias property (from manifest) and variantTitle property will automatically be added by the widget board.
-         */
-        raiseEvent?: (object: string, action: string, data?: {
-            [key: string]: string;
-        }) => void;
-    };
-    /**
-     * Metadata and functions in the context of a widget's variant (fka definition). A widget variant is
-     * a widget that's been installed by an administrator from within the board administration.
-     */
-    definition: {
-        /**
-         * Unique id of an installed and configured widget in the widget board.
-         * If this is a 'single instance widget', which means that no more than one instance of this
-         * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
-         */
-        id: string;
-        /**
-         * Optional configuration data that contains board-wide settings of a specific widget instance
-         */
-        data?: string;
-        /**
-         * A list of board types applicable for this widget variant.
-         */
-        allowedBoardTypes?: BoardType[];
-    };
-    /**
-     * Metadata and functions in the context of a widget's manifest. A widget manifest contains
-     * all information of the originally installed widget. Multiple `variants` of the same widget `manifest`
-     * can exist in a widget board configuration.
-     */
-    manifest: {
-        /**
-         * Unique id of a widget 'type', also used in the widget manifest config file in the original script source manifest file.
-         * If this is a 'single instance widget', which means that no more than one instance of this
-         * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
-         */
-        id: string;
-    };
-    /**
-     * Tells whether the widget board is running in a Teams context
-     */
-    inTeamsContext: boolean;
-    /**
-     * Tells whether the widget board is running in a Teams browser hosted context
-     */
-    isTeamsBrowserHosted: boolean;
-    /**
-     * Tells whether the widget board is running in a Teams webview hosted context
-     */
-    isTeamsWebViewHosted: boolean;
-    /**
-     * Tells whether the widget board is running in a SharePoint iOS app context
-     */
-    isSharePointiOSApp: boolean;
-    /**
-     * Tells whether the widget board is running in a webview hosted context
-     */
-    isWebViewHosted: boolean;
-    /**
-     * Tells whether the widget board is running in an embedded context
-     */
-    isEmbedded: boolean;
-    /**
-     * Tells whether the widget board is running in a mobile browser context
-     */
-    isMobileBrowser: boolean;
-    /**
-     * Tells whether the widget board is running in a mobile webview context
-     */
-    isMobileWebView: boolean;
-    /**
-     * Tenant ID of current SharePoint tenant
-     */
-    tenantId: string;
-    /**
-     * Site url of the site where the widget board is running
-     */
-    siteUrl: string;
-    /**
-     * User name of the currently signed in user.
-     */
-    userName: string;
-    /**
-     * The email address for the current user.
-     *
-     * @remarks
-     * Example: `"example@contoso.com"`
-     */
-    userEmail: string;
-    /**
-     * SharePoint ID of the user in the current site
-     */
-    spUserId: number;
-    /**
-     * Login name of current user in claim style: i:0#.f|myprovider|myuser
-     */
-    claimBasedLoginName: string;
-    /**
-     * Azure AD Security groups that user is member of
-     */
-    userSecurityGroups: string[];
-    /**
-     * SharePoint groups in this site collection that user is member of
-     */
-    userSharePointGroups: number[];
-    /**
-     * Provides the date that the user's account was created
-     */
-    userAccountCreated: Date;
-    /**
-     * Roles of the current user. This may very depending on the active board
-     */
-    userRoles: UserRole[];
-    /**
-     * Language code of currently used UI rendering language in SharePoint
-     */
-    language: string;
-    /**
-     * List of supported languages as configured in Widget Board configuration
-     */
-    contentLanguages: {
-        /**
-         * Numeric Locale ID, like 1033 for English - United States
-         */
-        LCID: number;
-        /**
-         * Language code, like 'en-US' for English - United States
-         */
-        BCP47LanguageTag: string;
-        /**
-         * 2 or 3 character uppercase language code, like 'EN' for English - United States
-         */
-        abbreviatedCode: string;
-        /**
-         * Friendly name of the language, translated in the currently used UI language
-         */
-        friendlyName: string;
-        /**
-         * Whether this is the default UI language of the Widget Board
-         */
-        isDefault?: boolean;
-        /**
-         * Whether this is the current UI language of the Widget Board
-         */
-        isCurrent?: boolean;
-    }[];
-    /**
-     * MS Graph Client Factory class as provided by the WebPartContext object.
-     */
-    msGraphClientFactory: any;
-    /**
-     * AAD Http Client Factory class as provided by the WebPartContext object.
-     */
-    aadHttpClientFactory: any;
-    /**
-     * AAD Token Provider Factory class as provided by the WebPartContext object.
-     */
-    aadTokenProviderFactory: any;
-    /**
-     * Currently in use theme (by SharePoint/Teams)
-     */
-    theme: any;
-    /**
-     * Returns whether or not the currently signed in user is part of an AAD security group.
-     * Provide the guid of the group.
-     */
-    isCurrentUserMemberOfSecGroup?: (groupId: string) => Promise<boolean>;
-    /**
-     * Returns whether or not the currently signed in user is part of a SharePoint group in the current site.
-     * Provide the id of the SP Group.
-     */
-    isCurrentUserMemberOfSPGroup?: (groupId: number) => Promise<boolean>;
-    /**
-     * Generates a hash of all combined SP Groups of the current user. This can be used as
-     * cache invalidator to detect changes.
-     * Store this hash as part of your local cache to detect when to refresh SP Group related data.
-     */
-    generateHashForAllCurrentUserSPGroups?: () => Promise<string>;
-    /**
-     * Generates a hash of all combined AAD Security Groups of the current user. This can be used as
-     * cache invalidator to detect changes.
-     * Store this hash as part of your local cache to detect when to refresh Sec Group related data.
-     */
-    generateHashForAllCurrentUserSecGroups?: () => Promise<string>;
-    /**
-     * Call this function from within one of the applicable render methods in case of an unresolvable error.
-     * The widgetboard will render a 'disrupted' message and in case of an error in widget rendering it
-     * offers the user the option to delete the widget from the board.
-     */
-    handleFatalError?: () => void;
-    /**
-     * Functionality offered by the widget board to load a script using SPComponentLoader.
-     */
-    loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
-    /**
-     * Functionality offered by the widget board to open a File Picker panel to select files.
-     * @param onFilePicked Function that's called when a file was picked. Returns the url of the picked file.
-     * @param options Options to change the behavior of the file picker
-     */
-    openFilePicker?: (onFilePicked: (fileUrl: string, fileProps: FilePickerFileProps) => void, options?: FilePickerOptions) => void;
-    /**
-     * Functionality offered by the widget board to open a url in an iframe dialog.
-     * @param url The url to open in a dialog.
-     * @param options Options to configure the dialog (e.g. size, margin, callbacks, ...)
-     */
-    openIFrameDialog?: (url: string, options?: IFrameDialogOptions) => void;
-    /**
-     * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.
-     */
-    teamsSdk?: {
-        /**
-         * Microsoft Teams SDK.
-         */
-        teamsJs: any;
-        /**
-         * {@inheritDoc @microsoft/teams-js#Context}
-         */
-        context: any;
-    };
-}
-export interface ValidationResult {
-    isValid: boolean;
-    errors: string[];
-}
-export interface WidgetImages {
-    preview: string;
-    preview_small: string;
-    additional: string[];
-}
-export interface WidgetResource {
-    lang: number;
-    title: string;
-    subtitle?: string;
-    shortDescription: string;
-    instructions: string;
-    images: WidgetImages;
-}
-export interface WebApiPermissionRequest {
-    /**
-     * Specifies the name of the resource service principle to wich access has been granted. Use the same principle names as in a SPPKG packages webApiPermissionRequests.
-     */
-    resource: string;
-    /**
-     * Specifies the name of the scope claim that the resource application should expect in the OAuth 2.0 access token. Use the same scope names as in a SPPKG packages webApiPermissionRequests.
-     */
-    scope: string;
-}
-/**
- * The widget manifest contains meta information about the widget
- */
-export interface WidgetManifestConfig {
-    /**
-     * Version of the widget manifest schema. The value of this field
-     * is controlled by Ichicraft. The purpose of this field is to help
-     * manage upgrades of the widget manifest schema.
-     * The current version is version 2, introducing externals + manifestVersion
-     * properties
-     */
-    manifestVersion: number;
-    /**
-     * Unique id to identify the widget
-     */
-    id: string;
-    /**
-     * Internal name for the widget, used internally by Ichicraft
-     */
-    name: string;
-    /**
-     * Version should contain the semver of this widget. For future use.
-     */
-    version: string;
-    /**
-     * The minimum number of rows this widget can inhabit in the widget board.
-     * By default, a widget always takes up 2 rows (and 1 column),
-     * If you want the widget to be able to shrink to 1 row, specify 1, otherwise, leave this
-     * property empty.
-     * _REMARK_: A value higher than 2 is considered invalid and will be ignored.
-     */
-    minRows: number;
-    /**
-     * The maximum number of rows this widget can inhabit in the widget board.
-     * By default, a widget always takes up 2 rows (and 1 column).
-     * Leave this empty and the maxRows will be defaulted to 2.
-     * Specify Inifinity to allow spanning any number of rows.
-     * _REMARK_: A value lower than 2 is considered invalid and will be ignored.
-     */
-    maxRows: number;
-    /**
-     * The maximum number of columns this widget can inhabit in the widget board.
-     * By default, a widget always takes up 1 column (and 2 rows).
-     * Leave this empty and the maxCols will be defaulted to 1.
-     * Specify Inifinity to allow spanning any number of columns.
-     * _REMARK_ A value lower than 1 is considered invalid and will be ignored.
-     */
-    maxCols: number;
-    /**
-     * Whether this widget is configurable by the user. Implementation of user config functions is necessary if true.
-     */
-    isConfigurableByUser: boolean;
-    /**
-     * Whether this widget is configurable by the board admin. Implementation of admin config functions is necessary if true.
-     */
-    isConfigurableByAdmin: boolean;
-    /**
-     * Internally used by Ichicraft
-     */
-    widgetBoardCompatibilityVersion?: number;
-    /**
-     * Icon used as prefix for notification sent by this widget. Icon should be the type id of a UI Fabric icon.
-     */
-    notificationIcon: string;
-    /**
-     * Language specific resources for this widget, used as default when installing a widget in the board
-     */
-    resources: WidgetResource[];
-    /**
-     * Web API permission requests. Like SPPKG packages, the widget specifies required API permissions.
-     */
-    webApiPermissionRequests?: WebApiPermissionRequest[];
-    /**
-     * This is the url of the widget script. It should be a well formatted url that points
-     * to the script file's unique location. Script files should be hosted on a secure website (https).
-     */
-    scriptUrl: string;
-    /**
-     * File path used when debugging a widget, this is set automatically when you debug a widget
-     */
-    bundleFilePath?: string;
-    /**
-     * Added in manifestVersion 2
-     * Lists modules (package dependencies) that should be loaded separately from bundle.
-     * Libraries mentioned here will not be bundled when packed as a production release,
-     * instead, they will be loaded from the provided path (path points to a CDN or other file location)
-     */
-    externals?: {
-        [name: string]: {
-            /**
-             * Path to the script file. If this is a module (e.g. AMD or UMD), make sure you also
-             * specify the modules this module depends on as separate modules using the correct aliases.
-             */
-            path: string;
-            /**
-             * Used for non-AMD scripts to specify dependencies. Should point to other non-AMD modules
-             */
-            globalDependencies?: string[];
-            /**
-             * In case this isn't an AMD module, define the variable name used by the script to
-             * make the module available (i.e. global/root/window variable name like jQuery or $)
-             */
-            globalName?: string;
-            /**
-             * If this module has dependencies, map them here to other externals you also specified
-             * For instance: external @fluentui/react umd module has dependencies React and ReactDOM.
-             * To point these to the right externals, map them like this:
-             * React: react
-             * ReactDOM: 'react-dom'
-             * And make sure you specified 'react' and 'react-dom' as externals as well.
-             */
-            dependencyMappings?: {
-                [name: string]: string;
-            };
-        };
-    };
-    /**
-     * Everything related to analytics of this widget in Ichicraft Boards
-     */
-    analytics?: {
-        /**
-         * A list of time-based events this widget can raise. All the possible events MUST be
-         * described in this list for the widget board to be able to pick them up.
-         * @ref Use WidgetContext.instance.raiseEvent(object: string, action: string, data?: { [key: string]: string }) to raise these events
-         */
-        timeBasedEvents: {
-            /**
-             * The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
-             */
-            object: string;
-            /**
-             * The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
-             */
-            action: string;
-            /**
-             * A descriptive text used in the Administration panel to describe this event
-             */
-            description: string;
-        }[];
-    };
-}
-export declare enum DebugComponentType {
-    /**
-     * This is the default component type and just opens the default widget board.
-     */
-    Default = "Default",
-    /**
-     * This automatically opens the widget board administration panel and opens the widget admin config
-     * dialog of the widget you're working on
-     */
-    AdminConfig = "AdminConfig"
-}
-/**
- * The widget debug serve config contains settings for debugging a widget in development
- */
-export interface WidgetDebugServeConfig {
-    /**
-     * Provide a url of a SharePoint site that hosts a widget board. This page will be opened
-     * as soon as you start debugging using [npm run start]
-     */
-    widgetsDebugPageUrl: string;
-    /**
-     * Provide a component type to open the debugging widget board with that specific component.
-     * This speeds up your development cycle: [npm run start] > save changes > builds automatically >
-     * refresh browser > automatically open updated component.
-     */
-    debugComponentType?: DebugComponentType;
-}
-export declare enum ICPersonaType {
-    User = 0,
-    SPGroup = 1,
-    Other = 2
-}
-export interface ICPersona {
-    displayName: string;
-    id: string;
-    type?: ICPersonaType;
-    resolved?: boolean;
-}
-/**
- * Tells the severity of the command bar item, resulting in
- * distinguishable presentation of the item
- */
-export declare enum CustomCommandBarItemSeverity {
-    /** Normal severity, displays just like all the other command bar items */
-    Normal = 0,
-    /** Warning severity, displays the item with a more noticable warning color */
-    Warning = 1
-}
-/**
- * Properties to pass to the generateCommandBarItem function, resulting in the
- * rendering of a command bar item, which could either be a single Icon or an Icon Button
- */
-export interface CustomCommandBarItemProps {
-    /**
-     * Optional identifier for the icon.
-     */
-    id?: string;
-    /**
-     * Name of the icon, as specified and available in Fluent UI Iconography:
-     * https://developer.microsoft.com/en-us/fluentui#/styles/web/icons
-     */
-    iconName: string;
-    /**
-     * Optional content to show as a tooltip above the item
-     */
-    tooltipContent?: string;
-    /**
-     * Optionally tells the tooltip to be shown automatically
-     */
-    showTooltipAutomatically?: boolean;
-    /**
-     * Optional severity to specify how the item should render
-     */
-    severity?: CustomCommandBarItemSeverity;
-    /**
-     * Optionally tells the Widget Header that this icon should always be visible, even when not hovering
-     */
-    pinned?: boolean;
-    /**
-     * Optionally display a red notification icon badge in the top-right corner of the button.
-     */
-    showNotificationBadge?: boolean;
-    /**
-     * Optionally provide an order in which this button should appear, when registering multiple custom buttons.
-     */
-    order?: number;
-    /**
-     * Optional onClick event, which is triggered on user click and makes the command
-     * bar item render as a button instead of a non-clickable icon
-     */
-    onClick?: () => void;
-}
-/**
- * Options to pass to the openIFrameDialog function. Use this to configure how the dialog is rendered, and to handle events (e.g. onDismissed)
- */
-export interface IFrameDialogOptions {
-    /**
-     * Maximum width of the dialog. If it exceeds the window width, that width is used instead.
-     */
-    maxWidth?: number;
-    /**
-     * Maximum height of the dialog. If it exceeds the window height, that height is used instead.
-     */
-    maxHeight?: number;
-    /**
-     * Minimum margin on the left- and right side of the dialog.
-     */
-    marginHorizontal?: number;
-    /**
-     * Minimum margin on the top- and bottom side of the dialog.
-     */
-    marginVertical?: number;
-    /**
-     * This event is triggered when the iFrame dialog is dismissed by the user.
-     */
-    onDismissed?: () => void;
-}
-/**
- * Options to pass to openFilePicker function
- */
-export interface FilePickerOptions {
-    /**
-     * Array of file extensions that will be used to filter the files in the picker.
-     * @default ['.gif', '.jpg', '.jpeg', '.png']
-     */
-    extensions?: string[];
-    /**
-     * Maximum number of files to show in a folder
-     * @default 100
-     */
-    itemsCountQueryLimit?: number;
-    /**
-     * Whether or not to hide the organisational site files tab
-     * @default false
-     */
-    hideOrganisationalAssetTab?: boolean;
-    /**
-     * Whether or not to hide the site files tab
-     * @default false
-     */
-    hideSiteFilesTab?: boolean;
-    /**
-     * Whether or not to hide the upload tab
-     * @default false
-     */
-    hideLocalUploadTab?: boolean;
-    /**
-     * Function that's called when user closes file picker without picking a file
-     * @default undefined
-     */
-    onCancel?: () => void;
-}
-export interface FilePickerFileProps {
-    /**
-     * Unique identifier of the file item in SharePoint, in the shape of a Guid.
-     */
-    uniqueId: string;
-    /**
-     * Unique identifier of the list in SharePoint, in the shape of a Guid.
-     */
-    listId: string;
-    /**
-     * Unique identifier of the site in SharePoint, in the shape of a Guid.
-     */
-    siteId: string;
-}
-export declare type BoardType = 'shared' | 'personal';
-export declare type UserRole = 'administrator' | 'board-owner';
+/**
+ * Widget context providing widget metadata and functionality offered by the widget board
+ */
+export interface WidgetContext {
+    /**
+     * metadata and functions in the context of a widget instance. A widget instance
+     * is a single and specific widget that a user has on his/her board. It has its own
+     * unique ID and possibly configuration data if the widget is configurable by the user
+     */
+    instance: {
+        /**
+         * Unique id for a specific widget on a user's board
+         */
+        id: string;
+        /**
+         * Optional configuration data that contains user settings of a specific widget instance
+         */
+        data?: string;
+        /**
+         * The type of board this widget instance is added to.
+         */
+        boardType?: BoardType;
+        /**
+         * Call this function from within a widget instance to publish a notification to the
+         * notitication box on top of the widget board. It should provide information for this specific
+         * widget instance. Notitifcation content is limited to one single line and a widget instance
+         * can only have one active notification at a time
+         */
+        publishNotification?: (content: string, expirationDateTime: Date) => void;
+        /**
+         * Call this function to open the widget configuration panel for a user. This is an additional
+         * way to open the panel because a user can also open the configuration panel by using the contextual
+         * menu of the widget.
+         */
+        openConfiguration?: () => void;
+        /**
+         * Call this function to open the widget delete confirmation dialog for a user. This offers widget developers
+         * the ability to trigger the "widget deletion process". This allows different methods to delete the widget.
+         */
+        initiateWidgetDeletion?: () => void;
+        /**
+         * Functionality offered by the widget board to change the title of the widget.
+         */
+        setWidgetTitle?: (title: string) => void;
+        /**
+         * Functionality offered by the widget board to append the title of the widget with additional text.
+         */
+        setWidgetTitleSuffix?: (suffix: string) => void;
+        /**
+         * Functionality offered by the widget board to change the subtitle of the widget.
+         */
+        setWidgetSubtitle?: (subtitle: string) => void;
+        /**
+         * Show or hide the header of the widget, allowing widgets to take control of full widget real estate.
+         */
+        setWidgetHeaderVisibility?: (visible: boolean) => void;
+        /**
+         * Show or hide the settings button of the widget.
+         */
+        setUserConfigButtonVisibility?: (visible: boolean) => void;
+        /**
+         * Optional callback to handle the click event of the widget title.
+         */
+        onWidgetTitleClicked?: () => void;
+        /**
+         * Allows registration of multiple custom command bar items which can either result in an icon or
+         * an icon button, depending on the presence of the onClick property. To remove the items,
+         * use the [unregisterCommandBarItems] function.
+         */
+        registerCustomCommandBarItems?: (props: CustomCommandBarItemProps[]) => void;
+        /**
+         * Allows registration of a custom command bar item which can either result in an icon or
+         * an icon button, depending on the presence of the onClick property. To remove the item,
+         * use the [unregisterCommandBarItem] function.
+         */
+        registerCustomCommandBarItem?: (props: CustomCommandBarItemProps) => void;
+        /**
+         * Removes all registered custom command bar items.
+         */
+        unregisterCustomCommandBarItems?: () => void;
+        /**
+         * Removes a single custom command bar item, corresponding to the provided id.
+         * If no id was specified, it removes all items.
+         */
+        unregisterCustomCommandBarItem?: (id?: string) => void;
+        /**
+         * Raises an event to be handled by the Time-based Events feature of Ichicraft Boards.
+         * @param object The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
+         * @param action The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
+         * @param data Optionally provide extra metadata to be included with the raised event.
+         * widgetAlias property (from manifest) and variantTitle property will automatically be added by the widget board.
+         */
+        raiseEvent?: (object: string, action: string, data?: {
+            [key: string]: string;
+        }) => void;
+    };
+    /**
+     * Metadata and functions in the context of a widget's variant (fka definition). A widget variant is
+     * a widget that's been installed by an administrator from within the board administration.
+     */
+    definition: {
+        /**
+         * Unique id of an installed and configured widget in the widget board.
+         * If this is a 'single instance widget', which means that no more than one instance of this
+         * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
+         */
+        id: string;
+        /**
+         * Optional configuration data that contains board-wide settings of a specific widget instance
+         */
+        data?: string;
+        /**
+         * A list of board types applicable for this widget variant.
+         */
+        allowedBoardTypes?: BoardType[];
+    };
+    /**
+     * Metadata and functions in the context of a widget's manifest. A widget manifest contains
+     * all information of the originally installed widget. Multiple `variants` of the same widget `manifest`
+     * can exist in a widget board configuration.
+     */
+    manifest: {
+        /**
+         * Unique id of a widget 'type', also used in the widget manifest config file in the original script source manifest file.
+         * If this is a 'single instance widget', which means that no more than one instance of this
+         * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
+         */
+        id: string;
+    };
+    /**
+     * Tells whether the widget board is running in a Teams context
+     */
+    inTeamsContext: boolean;
+    /**
+     * Tells whether the widget board is running in a Teams browser hosted context
+     */
+    isTeamsBrowserHosted: boolean;
+    /**
+     * Tells whether the widget board is running in a Teams webview hosted context
+     */
+    isTeamsWebViewHosted: boolean;
+    /**
+     * Tells whether the widget board is running in a SharePoint iOS app context
+     */
+    isSharePointiOSApp: boolean;
+    /**
+     * Tells whether the widget board is running in a webview hosted context
+     */
+    isWebViewHosted: boolean;
+    /**
+     * Tells whether the widget board is running in an embedded context
+     */
+    isEmbedded: boolean;
+    /**
+     * Tells whether the widget board is running in a mobile browser context
+     */
+    isMobileBrowser: boolean;
+    /**
+     * Tells whether the widget board is running in a mobile webview context
+     */
+    isMobileWebView: boolean;
+    /**
+     * Tenant ID of current SharePoint tenant
+     */
+    tenantId: string;
+    /**
+     * Site url of the site where the widget board is running
+     */
+    siteUrl: string;
+    /**
+     * User name of the currently signed in user.
+     */
+    userName: string;
+    /**
+     * The email address for the current user.
+     *
+     * @remarks
+     * Example: `"example@contoso.com"`
+     */
+    userEmail: string;
+    /**
+     * SharePoint ID of the user in the current site
+     */
+    spUserId: number;
+    /**
+     * Login name of current user in claim style: i:0#.f|myprovider|myuser
+     */
+    claimBasedLoginName: string;
+    /**
+     * Azure AD Security groups that user is member of
+     */
+    userSecurityGroups: string[];
+    /**
+     * SharePoint groups in this site collection that user is member of
+     */
+    userSharePointGroups: number[];
+    /**
+     * Provides the date that the user's account was created
+     */
+    userAccountCreated: Date;
+    /**
+     * Roles of the current user. This may very depending on the active board
+     */
+    userRoles: UserRole[];
+    /**
+     * Language code of currently used UI rendering language in SharePoint
+     */
+    language: string;
+    /**
+     * List of supported languages as configured in Widget Board configuration
+     */
+    contentLanguages: {
+        /**
+         * Numeric Locale ID, like 1033 for English - United States
+         */
+        LCID: number;
+        /**
+         * Language code, like 'en-US' for English - United States
+         */
+        BCP47LanguageTag: string;
+        /**
+         * 2 or 3 character uppercase language code, like 'EN' for English - United States
+         */
+        abbreviatedCode: string;
+        /**
+         * Friendly name of the language, translated in the currently used UI language
+         */
+        friendlyName: string;
+        /**
+         * Whether this is the default UI language of the Widget Board
+         */
+        isDefault?: boolean;
+        /**
+         * Whether this is the current UI language of the Widget Board
+         */
+        isCurrent?: boolean;
+    }[];
+    /**
+     * MS Graph Client Factory class as provided by the WebPartContext object.
+     */
+    msGraphClientFactory: any;
+    /**
+     * AAD Http Client Factory class as provided by the WebPartContext object.
+     */
+    aadHttpClientFactory: any;
+    /**
+     * AAD Token Provider Factory class as provided by the WebPartContext object.
+     */
+    aadTokenProviderFactory: any;
+    /**
+     * Currently in use theme (by SharePoint/Teams)
+     */
+    theme: any;
+    /**
+     * Returns whether or not the currently signed in user is part of an AAD security group.
+     * Provide the guid of the group.
+     */
+    isCurrentUserMemberOfSecGroup?: (groupId: string) => Promise<boolean>;
+    /**
+     * Returns whether or not the currently signed in user is part of a SharePoint group in the current site.
+     * Provide the id of the SP Group.
+     */
+    isCurrentUserMemberOfSPGroup?: (groupId: number) => Promise<boolean>;
+    /**
+     * Generates a hash of all combined SP Groups of the current user. This can be used as
+     * cache invalidator to detect changes.
+     * Store this hash as part of your local cache to detect when to refresh SP Group related data.
+     */
+    generateHashForAllCurrentUserSPGroups?: () => Promise<string>;
+    /**
+     * Generates a hash of all combined AAD Security Groups of the current user. This can be used as
+     * cache invalidator to detect changes.
+     * Store this hash as part of your local cache to detect when to refresh Sec Group related data.
+     */
+    generateHashForAllCurrentUserSecGroups?: () => Promise<string>;
+    /**
+     * Call this function from within one of the applicable render methods in case of an unresolvable error.
+     * The widgetboard will render a 'disrupted' message and in case of an error in widget rendering it
+     * offers the user the option to delete the widget from the board.
+     */
+    handleFatalError?: () => void;
+    /**
+     * Functionality offered by the widget board to load a script using SPComponentLoader.
+     */
+    loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
+    /**
+     * Functionality offered by the widget board to open a File Picker panel to select files.
+     * @param onFilePicked Function that's called when a file was picked. Returns the url of the picked file.
+     * @param options Options to change the behavior of the file picker
+     */
+    openFilePicker?: (onFilePicked: (fileUrl: string, fileProps: FilePickerFileProps) => void, options?: FilePickerOptions) => void;
+    /**
+     * Functionality offered by the widget board to open a url in an iframe dialog.
+     * @param url The url to open in a dialog.
+     * @param options Options to configure the dialog (e.g. size, margin, callbacks, ...)
+     */
+    openIFrameDialog?: (url: string, options?: IFrameDialogOptions) => void;
+    /**
+     * Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.
+     */
+    teamsSdk?: {
+        /**
+         * Microsoft Teams SDK.
+         */
+        teamsJs: any;
+        /**
+         * {@inheritDoc @microsoft/teams-js#Context}
+         */
+        context: any;
+    };
+}
+export interface ValidationResult {
+    isValid: boolean;
+    errors: string[];
+}
+export interface WidgetImages {
+    preview: string;
+    preview_small: string;
+    additional: string[];
+}
+export interface WidgetResource {
+    lang: number;
+    title: string;
+    subtitle?: string;
+    shortDescription: string;
+    instructions: string;
+    images: WidgetImages;
+}
+export interface WebApiPermissionRequest {
+    /**
+     * Specifies the name of the resource service principle to wich access has been granted. Use the same principle names as in a SPPKG packages webApiPermissionRequests.
+     */
+    resource: string;
+    /**
+     * Specifies the name of the scope claim that the resource application should expect in the OAuth 2.0 access token. Use the same scope names as in a SPPKG packages webApiPermissionRequests.
+     */
+    scope: string;
+}
+/**
+ * The widget manifest contains meta information about the widget
+ */
+export interface WidgetManifestConfig {
+    /**
+     * Version of the widget manifest schema. The value of this field
+     * is controlled by Ichicraft. The purpose of this field is to help
+     * manage upgrades of the widget manifest schema.
+     * The current version is version 2, introducing externals + manifestVersion
+     * properties
+     */
+    manifestVersion: number;
+    /**
+     * Unique id to identify the widget
+     */
+    id: string;
+    /**
+     * Internal name for the widget, used internally by Ichicraft
+     */
+    name: string;
+    /**
+     * Version should contain the semver of this widget. For future use.
+     */
+    version: string;
+    /**
+     * The minimum number of rows this widget can inhabit in the widget board.
+     * By default, a widget always takes up 2 rows (and 1 column),
+     * If you want the widget to be able to shrink to 1 row, specify 1, otherwise, leave this
+     * property empty.
+     * _REMARK_: A value higher than 2 is considered invalid and will be ignored.
+     */
+    minRows: number;
+    /**
+     * The maximum number of rows this widget can inhabit in the widget board.
+     * By default, a widget always takes up 2 rows (and 1 column).
+     * Leave this empty and the maxRows will be defaulted to 2.
+     * Specify Inifinity to allow spanning any number of rows.
+     * _REMARK_: A value lower than 2 is considered invalid and will be ignored.
+     */
+    maxRows: number;
+    /**
+     * The maximum number of columns this widget can inhabit in the widget board.
+     * By default, a widget always takes up 1 column (and 2 rows).
+     * Leave this empty and the maxCols will be defaulted to 1.
+     * Specify Inifinity to allow spanning any number of columns.
+     * _REMARK_ A value lower than 1 is considered invalid and will be ignored.
+     */
+    maxCols: number;
+    /**
+     * Whether this widget is configurable by the user. Implementation of user config functions is necessary if true.
+     */
+    isConfigurableByUser: boolean;
+    /**
+     * Whether this widget is configurable by the board admin. Implementation of admin config functions is necessary if true.
+     */
+    isConfigurableByAdmin: boolean;
+    /**
+     * Internally used by Ichicraft
+     */
+    widgetBoardCompatibilityVersion?: number;
+    /**
+     * Icon used to represent this widget, used as default when installing a widget in the board. Icon should be the type id of a UI Fabric icon.
+     */
+    iconName: string;
+    /**
+     * Language specific resources for this widget, used as default when installing a widget in the board
+     */
+    resources: WidgetResource[];
+    /**
+     * Web API permission requests. Like SPPKG packages, the widget specifies required API permissions.
+     */
+    webApiPermissionRequests?: WebApiPermissionRequest[];
+    /**
+     * This is the url of the widget script. It should be a well formatted url that points
+     * to the script file's unique location. Script files should be hosted on a secure website (https).
+     */
+    scriptUrl: string;
+    /**
+     * File path used when debugging a widget, this is set automatically when you debug a widget
+     */
+    bundleFilePath?: string;
+    /**
+     * Added in manifestVersion 2
+     * Lists modules (package dependencies) that should be loaded separately from bundle.
+     * Libraries mentioned here will not be bundled when packed as a production release,
+     * instead, they will be loaded from the provided path (path points to a CDN or other file location)
+     */
+    externals?: {
+        [name: string]: {
+            /**
+             * Path to the script file. If this is a module (e.g. AMD or UMD), make sure you also
+             * specify the modules this module depends on as separate modules using the correct aliases.
+             */
+            path: string;
+            /**
+             * Used for non-AMD scripts to specify dependencies. Should point to other non-AMD modules
+             */
+            globalDependencies?: string[];
+            /**
+             * In case this isn't an AMD module, define the variable name used by the script to
+             * make the module available (i.e. global/root/window variable name like jQuery or $)
+             */
+            globalName?: string;
+            /**
+             * If this module has dependencies, map them here to other externals you also specified
+             * For instance: external @fluentui/react umd module has dependencies React and ReactDOM.
+             * To point these to the right externals, map them like this:
+             * React: react
+             * ReactDOM: 'react-dom'
+             * And make sure you specified 'react' and 'react-dom' as externals as well.
+             */
+            dependencyMappings?: {
+                [name: string]: string;
+            };
+        };
+    };
+    /**
+     * Everything related to analytics of this widget in Ichicraft Boards
+     */
+    analytics?: {
+        /**
+         * A list of time-based events this widget can raise. All the possible events MUST be
+         * described in this list for the widget board to be able to pick them up.
+         * @ref Use WidgetContext.instance.raiseEvent(object: string, action: string, data?: { [key: string]: string }) to raise these events
+         */
+        timeBasedEvents: {
+            /**
+             * The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
+             */
+            object: string;
+            /**
+             * The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
+             */
+            action: string;
+            /**
+             * A descriptive text used in the Administration panel to describe this event
+             */
+            description: string;
+        }[];
+    };
+}
+export declare enum DebugComponentType {
+    /**
+     * This is the default component type and just opens the default widget board.
+     */
+    Default = "Default",
+    /**
+     * This automatically opens the widget board administration panel and opens the widget admin config
+     * dialog of the widget you're working on
+     */
+    AdminConfig = "AdminConfig"
+}
+/**
+ * The widget debug serve config contains settings for debugging a widget in development
+ */
+export interface WidgetDebugServeConfig {
+    /**
+     * Provide a url of a SharePoint site that hosts a widget board. This page will be opened
+     * as soon as you start debugging using [npm run start]
+     */
+    widgetsDebugPageUrl: string;
+    /**
+     * Provide a component type to open the debugging widget board with that specific component.
+     * This speeds up your development cycle: [npm run start] > save changes > builds automatically >
+     * refresh browser > automatically open updated component.
+     */
+    debugComponentType?: DebugComponentType;
+}
+export declare enum ICPersonaType {
+    User = 0,
+    SPGroup = 1,
+    Other = 2
+}
+export interface ICPersona {
+    displayName: string;
+    id: string;
+    type?: ICPersonaType;
+}
+/**
+ * Tells the severity of the command bar item, resulting in
+ * distinguishable presentation of the item
+ */
+export declare enum CustomCommandBarItemSeverity {
+    /** Normal severity, displays just like all the other command bar items */
+    Normal = 0,
+    /** Warning severity, displays the item with a more noticable warning color */
+    Warning = 1
+}
+/**
+ * Properties to pass to the generateCommandBarItem function, resulting in the
+ * rendering of a command bar item, which could either be a single Icon or an Icon Button
+ */
+export interface CustomCommandBarItemProps {
+    /**
+     * Optional identifier for the icon.
+     */
+    id?: string;
+    /**
+     * Name of the icon, as specified and available in Fluent UI Iconography:
+     * https://developer.microsoft.com/en-us/fluentui#/styles/web/icons
+     */
+    iconName: string;
+    /**
+     * Optional content to show as a tooltip above the item
+     */
+    tooltipContent?: string;
+    /**
+     * Optionally tells the tooltip to be shown automatically
+     */
+    showTooltipAutomatically?: boolean;
+    /**
+     * Optional severity to specify how the item should render
+     */
+    severity?: CustomCommandBarItemSeverity;
+    /**
+     * Optionally tells the Widget Header that this icon should always be visible, even when not hovering
+     */
+    pinned?: boolean;
+    /**
+     * Optionally display a red notification icon badge in the top-right corner of the button.
+     */
+    showNotificationBadge?: boolean;
+    /**
+     * Optionally provide an order in which this button should appear, when registering multiple custom buttons.
+     */
+    order?: number;
+    /**
+     * Optional onClick event, which is triggered on user click and makes the command
+     * bar item render as a button instead of a non-clickable icon
+     */
+    onClick?: () => void;
+}
+/**
+ * Options to pass to the openIFrameDialog function. Use this to configure how the dialog is rendered, and to handle events (e.g. onDismissed)
+ */
+export interface IFrameDialogOptions {
+    /**
+     * Maximum width of the dialog. If it exceeds the window width, that width is used instead.
+     */
+    maxWidth?: number;
+    /**
+     * Maximum height of the dialog. If it exceeds the window height, that height is used instead.
+     */
+    maxHeight?: number;
+    /**
+     * Minimum margin on the left- and right side of the dialog.
+     */
+    marginHorizontal?: number;
+    /**
+     * Minimum margin on the top- and bottom side of the dialog.
+     */
+    marginVertical?: number;
+    /**
+     * This event is triggered when the iFrame dialog is dismissed by the user.
+     */
+    onDismissed?: () => void;
+}
+/**
+ * Options to pass to openFilePicker function
+ */
+export interface FilePickerOptions {
+    /**
+     * Array of file extensions that will be used to filter the files in the picker.
+     * @default ['.gif', '.jpg', '.jpeg', '.png']
+     */
+    extensions?: string[];
+    /**
+     * Maximum number of files to show in a folder
+     * @default 100
+     */
+    itemsCountQueryLimit?: number;
+    /**
+     * Whether or not to hide the organisational site files tab
+     * @default false
+     */
+    hideOrganisationalAssetTab?: boolean;
+    /**
+     * Whether or not to hide the site files tab
+     * @default false
+     */
+    hideSiteFilesTab?: boolean;
+    /**
+     * Whether or not to hide the upload tab
+     * @default false
+     */
+    hideLocalUploadTab?: boolean;
+    /**
+     * Function that's called when user closes file picker without picking a file
+     * @default undefined
+     */
+    onCancel?: () => void;
+}
+export interface FilePickerFileProps {
+    /**
+     * Unique identifier of the file item in SharePoint, in the shape of a Guid.
+     */
+    uniqueId: string;
+    /**
+     * Unique identifier of the list in SharePoint, in the shape of a Guid.
+     */
+    listId: string;
+    /**
+     * Unique identifier of the site in SharePoint, in the shape of a Guid.
+     */
+    siteId: string;
+}
+export declare type BoardType = 'shared' | 'personal';
+export declare type UserRole = 'administrator' | 'board-owner';