chore: update build

Author: Kaushik Shetty

dist/index.js

@@ -13,29 +13,58 @@ declare class AssetSidebarWidget {
     _connection: typeof postRobot;
     _changedData?: GenericObjectType;
     constructor(initializationData: IAssetSidebarInitData, connection: typeof postRobot, emitter: EventEmitter);
+    /**
+     * Get the current asset data.
+     * @returns {AssetData} The current asset data.
+     */
     getData(): AssetType;
+    /**
+     * Set data for the asset.
+     * @param {Partial<setAssetDto>} asset - The partial asset data to set.
+     * @returns {Promise<void>} A promise that resolves when the data is set successfully.
+     */
     setData(asset: Partial<setAssetDto>): Promise<void>;
+    /**
+     * Synchronize the asset with the parent application in the Contentstack UI.
+     * @returns {Promise<void>} A promise that resolves when the synchronization is complete.
+     */
     syncAsset(): Promise<void>;
+    /**
+     * Update the width of the Asset Sidebar widget in the Contentstack UI.
+     * @param {number} width - The new width of the asset sidebar.
+     * @throws {Error} Throws an error if the width parameter is not a number.
+     * @returns {Promise<void>} A promise that resolves when the width is updated successfully.
+     */
     updateWidth(width: number): Promise<void>;
-    replaceAsset(file: File): Promise<any>;
     /**
-     * This function executes the callback function every time an asset is saved.
-     * @param {function} callback The function to be called when an asset is saved.
+     * Replace the current asset with a new file.
+     * @param {File} file - The file to be used as the replacement asset.
+     * @returns {Promise<void>} A promise that resolves when the replacement is complete.
+     */
+    replaceAsset(file: File): Promise<void>;
+    /**
+     * Executes the provided callback function every time an asset is saved.
+     * @param {function} callback - The function to be called when an asset is saved.
+     * @param {AssetType} arg0 - The asset data passed as an argument to the callback function when an asset is saved.
      */
     onSave(callback: (arg0: AssetType) => void): void;
     /**
-     * The field.onChange() function is called when another extension programmatically changes the data of the current extension field using the field.setData() function. This function is only available for extension fields that support the following data types: text, number, boolean, or date.
-     * @param {function} callback The function to be called when an asset is edited/changed.
+     * The `field.onChange()` function is called when another extension programmatically changes the data of the current extension field using the `field.setData()` function.
+     * This function is only available for extension fields that support the following data types: text, number, boolean, or date.
+     * @param {function} callback - The function to be called when the asset is edited/changed.
+     * @param {AssetType} arg0 - The asset data passed as an argument to the callback function when the asset is edited/changed.
      */
     onChange(callback: (arg0: AssetType) => void): void;
     /**
      * The onPublish() function executes the callback function every time an asset has been published with the respective payload.
-     * @param {function} callback The function to be called when an asset is published.
+     * @param {function} callback - The function to be called when an asset is published.
+     * @param {AssetType} arg0 - The data of the published asset passed as an argument to the callback function.
      */
     onPublish(callback: (arg0: AssetType) => void): void;
     /**
-     * The onUnPublish() function executes the callback function every time an asset has been unpublished with the respective payload.
-     * @param {function} callback The function to be called when an asset is un published.
+     * The `onUnPublish()` function executes the provided callback every time an asset is unpublished.
+     * @param {function} callback - The function to be called when an asset is unpublished.
+     * @param {AssetType} arg0 - The data of the unpublished asset passed as an argument to the callback function.
      */
     onUnPublish(callback: (arg0: AssetType) => void): void;
 }

dist/index.js.map

@@ -1,7 +1,6 @@
-import Stack from "../stack";
 import postRobot from "post-robot";
+import Stack from "../stack";
 import { IInstallationData, ValidationOptions, IAppConfigInitData } from "../types";
-import { GenericObjectType } from "../types/common.types";
 export declare interface AppConfigAdditionalData {
     currentBranch: string;
 }
@@ -15,13 +14,13 @@ export declare class AppConfig {
     private _additionalData;
     constructor(data: IAppConfigInitData, connection: typeof postRobot, emitter: EventEmitter, additionalData: AppConfigAdditionalData);
     stack: () => Stack;
-    setInstallationData: (installationData: IInstallationData) => Promise<GenericObjectType>;
+    setInstallationData: (installationData: IInstallationData) => Promise<IInstallationData>;
     getInstallationData: () => Promise<IInstallationData>;
     /**
      * Sets the validation state of the app. If the validation is false, the Contentstack App Config
      * will not allow saving the configuration. The message will be displayed if provided.
      * @param {boolean} isValid - The validation state of the app.
-     * @param {object} options - Additional options to be sent to the parent.
+     * @param {ValidationOptions} options - Additional options to be sent to the parent.
      * @returns {Promise<void>} - A promise that resolves to void.
      */
     setValidity(isValid: boolean, options?: ValidationOptions): Promise<void>;

dist/src/AssetSidebarWidget.d.ts

@@ -16,11 +16,7 @@ declare class Field {
     _resolvedData: GenericObjectType;
     _self: boolean;
     _connection: typeof postRobot;
-    constructor(
-        fieldDataObject: IFieldInitData | IFieldModifierLocationInitData,
-        connection: typeof postRobot,
-        emitter: EventEmitter
-    );
+    constructor(fieldDataObject: IFieldInitData | IFieldModifierLocationInitData, connection: typeof postRobot, emitter: EventEmitter);
     /**
      * Sets the data for the current field.
      * @param {Object|string|number} data Data to be set on the field
@@ -33,9 +29,7 @@ declare class Field {
      * @param  {boolean} options.resolved If the resolved parameter is set to true for the File field, then the method will return a resolved asset object along with all the field metadata, e.g. 'field.getData({resolved:true})'.
      * @return {Object|string|number} Returns the field data.
      */
-    getData({
-        resolved,
-    }?: {
+    getData({ resolved }?: {
         resolved?: boolean | undefined;
     }): GenericObjectType;
     /**
@@ -50,4 +44,4 @@ declare class Field {
     onChange?(callback: (data: any) => any): void;
 }
 export default Field;
-//# sourceMappingURL=field.d.ts.map
+//# sourceMappingURL=field.d.ts.map

dist/src/AssetSidebarWidget.d.ts.map

@@ -1,4 +1,5 @@
 import EventEmitter from "wolfy87-eventemitter";
+import postRobot from "post-robot";
 import { DashboardWidth, LocationType } from "./types";
 /**
  * Class representing an iframe window from Contentstack UI. Not available for Custom Widgets.
@@ -14,12 +15,7 @@ declare class Window {
     _emitter: EventEmitter;
     state: DashboardWidth;
     _height?: number;
-    constructor(
-        connection: any,
-        type: LocationType.DASHBOARD | LocationType.FIELD,
-        emitter: EventEmitter,
-        state?: DashboardWidth
-    );
+    constructor(connection: any, type: LocationType.DASHBOARD | LocationType.FIELD, emitter: EventEmitter, state?: DashboardWidth);
     /**
      * Activates the resize button that allows you to resize the window size of your Dashboard Widget.
      * @return {Promise} A promise that resolves when the resize button becomes visible on the Dashboard Widget.
@@ -60,4 +56,4 @@ declare class Window {
     disablePaddingTop(): Promise<void>;
 }
 export default Window;
-//# sourceMappingURL=window.d.ts.map
+//# sourceMappingURL=window.d.ts.map