Skip to content

Commit 29f093e

Browse files
author
Kaushik Shetty
committed
chore: update build
1 parent 57a1680 commit 29f093e

24 files changed

+306
-1121
lines changed

dist/index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 931 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/src/AssetSidebarWidget.d.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { IAssetSidebarInitData, setAssetDto } from "./types";
33
import postRobot from "post-robot";
44
import { Asset as AssetType } from "./types/stack.types";
55
import { GenericObjectType } from "./types/common.types";
6-
/** Class representing an asset Extension from Contentstack UI. */
6+
/** Class representing an Asset Sidebar UI Location from Contentstack UI. */
77
declare class AssetSidebarWidget {
88
/**
99
* @hideconstructor
@@ -49,10 +49,9 @@ declare class AssetSidebarWidget {
4949
*/
5050
onSave(callback: (arg0: AssetType) => void): void;
5151
/**
52-
* The `field.onChange()` function is called when another extension programmatically changes the data of the current extension field using the `field.setData()` function.
53-
* This function is only available for extension fields that support the following data types: text, number, boolean, or date.
54-
* @param {function} callback - The function to be called when the asset is edited/changed.
55-
* @param {AssetType} arg0 - The asset data passed as an argument to the callback function when the asset is edited/changed.
52+
* Registers a callback function to be executed whenever there is a change made to the Asset.
53+
* @param {function} callback - The function to be called when the asset is edited or changed.
54+
* @param {AssetType} arg0 - The asset data passed as an argument to the callback function when the asset is edited or changed.
5655
*/
5756
onChange(callback: (arg0: AssetType) => void): void;
5857
/**

dist/src/AssetSidebarWidget.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/src/entry.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import Field from "./field";
44
import { IFieldInitData, IFieldModifierLocationInitData, ISidebarInitData } from "./types";
55
import { Entry as EntryType } from "../src/types/entry.types";
66
import { IEntryOptions, IGetFieldOptions, IOnEntryChangeCallback } from "./types/entry.types";
7-
import { ContentType } from "./types/stack.types";
7+
import { ContentType, PublishDetails } from "./types/stack.types";
88
import { GenericObjectType } from "./types/common.types";
9-
/** Class representing an entry from Contentstack UI. Not available for Dashboard Widget extension. */
9+
/** Class representing an entry from Contentstack UI. Not available for Dashboard UI Location. */
1010
declare class Entry {
1111
/**
1212
* @hideconstructor
@@ -26,8 +26,8 @@ declare class Entry {
2626
getData(): EntryType;
2727
/**
2828
* Gets the field object for the saved data, which allows you to interact with the field.
29-
* This object will have all the same methods and properties of extension.field.
30-
* Note: For fields initialized using the getFields function, the setData function currently works only for the following fields: as single_line, multi_line, RTE, markdown, select, number, boolean, date, link, and extension of data type text, number, boolean, and date.
29+
* This object will have all the same methods and properties of appSDK.location.CustomField.field.
30+
* Note: For fields initialized using the getFields function, the setData function currently works only for the following fields: as single_line, multi_line, RTE, markdown, select, number, boolean, date, link, and Custom Field UI Location of data type text, number, boolean, and date.
3131
* @example
3232
* var field = entry.getField('field_uid');
3333
* var fieldSchema = field.schema;
@@ -44,20 +44,20 @@ declare class Entry {
4444
*/
4545
onSave(callback: (arg0: EntryType) => void): void;
4646
/**
47-
* 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.
48-
* @param {function} callback The function to be called when an entry is edited/changed.
47+
* The onChange() function executes the provided callback function whenever an entry is updated.
48+
* @param {function} callback - The function to be called when the entry is edited or changed.
4949
*/
5050
onChange(callback: IOnEntryChangeCallback): void;
5151
/**
5252
* The onPublish() function executes the callback function every time an entry has been published with the respective payload.
5353
* @param {function} callback The function to be called when an entry is published.
5454
*/
55-
onPublish(callback: (arg0: EntryType) => void): void;
55+
onPublish(callback: (arg0: PublishDetails) => void): void;
5656
/**
5757
* The onUnPublish() function executes the callback function every time an entry has been unpublished with the respective payload.
5858
* @param {function} callback The function to be called when an entry is un published.
5959
*/
60-
onUnPublish(callback: (arg0: EntryType) => void): void;
60+
onUnPublish(callback: (arg0: PublishDetails) => void): void;
6161
}
6262
export default Entry;
6363
//# sourceMappingURL=entry.d.ts.map

dist/src/entry.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/src/field.d.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import postRobot from "post-robot";
33
import { IFieldInitData, IFieldModifierLocationInitData } from "./types";
44
import { GenericObjectType } from "./types/common.types";
55
import { Schema } from "./types/stack.types";
6-
/** Class representing a field from Contentstack UI. Only available for Custom Field extension */
6+
/** Class representing a field from Contentstack UI. Only available for Custom Field and Field Modifier UI Location */
77
declare class Field {
88
/**
99
* @hideconstructor
@@ -33,13 +33,14 @@ declare class Field {
3333
resolved?: boolean | undefined;
3434
}): GenericObjectType;
3535
/**
36-
* Sets the focus for a field when an extension is being used. This method shows user presence and highlights the extension field that the user is currently accessing in Contentstack UI.
37-
* @return {Promise<void} A promise object which is resolved when Contentstack UI returns an acknowledgement of the focused state.
36+
* Sets the focus for a field when an App is being used. This method shows user presence and highlights the App's Custom Field that the user is currently accessing in Contentstack UI.
37+
* @return {Promise<void>} A promise object which is resolved when Contentstack UI returns an acknowledgement of the focused state.
3838
*/
3939
setFocus(): Promise<void>;
4040
/**
41-
* This function is called when another extension programmatically changes data of this field using field.setData() function, only available for extension field, only support extensions of data type text, number, boolean or date.
42-
* @param {function} callback The function to be called when an entry is published.
41+
* The `onChange` function is triggered when another extension or app programmatically modifies the data of this field using the `field.setData()` function.
42+
* It is specifically designed for App's Custom Fields of data types text, number, boolean, or date.
43+
* @param {function} callback The function to be called when a field has been updated.
4344
*/
4445
onChange?(callback: (data: any) => any): void;
4546
}

dist/src/field.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/src/fieldModifierLocation/field.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import postRobot from "post-robot";
33
import { IFieldInitData, IFieldModifierLocationInitData } from "../types";
44
import { GenericObjectType } from "../types/common.types";
55
import { Schema } from "../types/stack.types";
6-
/** Class representing a field from Contentstack UI. Only available for Custom Field extension */
6+
/** Class representing a field from Contentstack UI. */
77
declare class FieldModifierLocationField {
88
/**
99
* @hideconstructor

dist/src/fieldModifierLocation/field.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)